public
interface
SubscriptionFileWidget
implements SubscriptionWidget| com.microstrategy.web.app.gui.SubscriptionFileWidget |
 Known Indirect Subclasses
|
This interface is deprecated.
Please use SubscriptionFileWidget from the transforms package.
Class Overview
Renders the Widget to create/edit Narrowcast File Subscriptions.
Summary
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.web.app.gui.SubscriptionWidget
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract String | getFileName() | ||||||||||
| abstract String | getFileNameArg() | ||||||||||
| abstract boolean | getIsDeliveryNotificationAvailable() | ||||||||||
| abstract String | getNotificationAddressArg() | ||||||||||
| abstract String | getNotificationAddressId() | ||||||||||
| abstract String | getNotificationAddressTypeArg() | ||||||||||
| abstract SimpleList | getNotificationAddresses() | ||||||||||
| abstract String | getNotificationDeviceArg() | ||||||||||
| abstract String | getNotificationDeviceId() | ||||||||||
| abstract SimpleList | getNotificationDevices() | ||||||||||
| abstract String | getNotificationNewAddressArg() | ||||||||||
| abstract String | getNotificationNewAddressValue() | ||||||||||
| abstract boolean | getUseDeliveryNotification() | ||||||||||
| abstract String | getUseDeliveryNotificationArg() | ||||||||||
| abstract void |
renderAvailableLocations(MarkupOutput out, SimpleList locations, String locationID, String argLocation)
Renders the list of available locations for the Subscriptions.
| ||||||||||
| abstract void |
renderNotificationAddressList(MarkupOutput out, SimpleList addresses, String addressId, String addressArg, String addressTypeArg, String newAddressValue, String newAddressArg, SimpleList devices, String deviceId, String deviceArg, boolean bUseNotification)
Renders the list of addresses for the Subscription.
| ||||||||||
| abstract void |
setFileName(String value)
Sets the name of the file to which the export will be sent.
| ||||||||||
| abstract void |
setFileNameArg(String value)
The FileName argument name.
| ||||||||||
| abstract void |
setIsBulkExport(boolean value)
Set to true if the current object is a bulk export report.
| ||||||||||
| abstract void |
setIsDeliveryNotificationAvailable(boolean value)
Set to true if the feature for creating delivery notification is available.
| ||||||||||
| abstract void |
setNotificationAddressArg(String value)
The name of the adressId argument
| ||||||||||
| abstract void |
setNotificationAddressId(String value)
Sets the value of the current addressId used when creating subscriptions
to existing addresses
| ||||||||||
| abstract void |
setNotificationAddressTypeArg(String value)
The name of the adressType argument.
| ||||||||||
| abstract void |
setNotificationAddresses(SimpleList value)
The global list of addresses to use for this subscription
| ||||||||||
| abstract void |
setNotificationDeviceArg(String value)
The name of the deviceId argument for new addresses.
| ||||||||||
| abstract void |
setNotificationDeviceId(String value)
The current deviceId.
| ||||||||||
| abstract void |
setNotificationDevices(SimpleList value)
Sets the global list of devices to use for new addresses
| ||||||||||
| abstract void |
setNotificationNewAddressArg(String value)
The name of the newAddress argument.
| ||||||||||
| abstract void |
setNotificationNewAddressValue(String value)
The value of the address list used when creating subscriptions
to new addresses
| ||||||||||
| abstract void |
setUseDeliveryNotification(boolean value)
Set to true if delivery notification is currently used.
| ||||||||||
| abstract void |
setUseDeliveryNotificationArg(String value)
The name of the useDeliveryNotification argument.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From interface
com.microstrategy.web.app.gui.DefaultSubscriptionWidget
| |||||||||||
|
From interface
com.microstrategy.web.app.gui.GuiElement
| |||||||||||
|
From interface
com.microstrategy.web.app.gui.SubscriptionWidget
| |||||||||||
Public Methods
public abstract String getFileName ()
Returns
- the name of the file to which the export will be sent.
public abstract String getFileNameArg ()
Returns
- The FileName argument name.
public abstract boolean getIsDeliveryNotificationAvailable ()
Returns
- true if the feature for creating delivery notification is available.
public abstract String getNotificationAddressArg ()
Returns
- The name of the addressId argument
public abstract String getNotificationAddressId ()
Returns
- the value of the current addressId used when creating subscriptions to existing addresses
public abstract String getNotificationAddressTypeArg ()
Returns
- the name for the addressType argument.
public abstract String getNotificationDeviceArg ()
Returns
- The deviceId argument name for new addresses.
public abstract String getNotificationDeviceId ()
Returns
- The current deviceId. This is the device used for new addresses
public abstract String getNotificationNewAddressArg ()
Returns
- the newAddress argument name
public abstract String getNotificationNewAddressValue ()
Returns
- a comma separated list of addresses used when creating subscriptions to new addresses
public abstract boolean getUseDeliveryNotification ()
Returns
- true if delivery notification is currently used.
public abstract String getUseDeliveryNotificationArg ()
Returns
- The useDeliveryNotification argument name.
public abstract void renderAvailableLocations (MarkupOutput out, SimpleList locations, String locationID, String argLocation)
Renders the list of available locations for the Subscriptions. This method can be called stand
alone by passing the required arguments. It's also part of the renderElement()
method that passes the global widget values properties as the arguments.
Parameters
| out | Where to write the widget's output |
|---|---|
| locations | the list of locations |
| locationID | the current location ID |
| argLocation | the name of the location ID argument |
public abstract void renderNotificationAddressList (MarkupOutput out, SimpleList addresses, String addressId, String addressArg, String addressTypeArg, String newAddressValue, String newAddressArg, SimpleList devices, String deviceId, String deviceArg, boolean bUseNotification)
Renders the list of addresses for the Subscription. This method can be called stand
alone by passing the required arguments. It's also part of the renderElement()
method that passes the global widget values properties as the arguments.
Parameters
| out | Where to write the widget's output |
|---|---|
| addresses | the list of addresses |
| addressId | the id of the current address |
| addressArg | the name of the addressId arg |
| addressTypeArg | the name of the addressType arg |
| newAddressValue | the value for the new address list |
| newAddressArg | the name of the new address list argument |
| devices | the list of devices |
| deviceId | the current deviceId |
| deviceArg | the name of the deviceId argument |
| bUseNotification | the boolean argument to denote whether the subscription uses notification |
public abstract void setFileName (String value)
Sets the name of the file to which the export will be sent.
Parameters
| value | the name of the file to which the export will be sent. |
|---|
public abstract void setFileNameArg (String value)
The FileName argument name.
Parameters
| value | The FileName argument name. |
|---|
public abstract void setIsBulkExport (boolean value)
Set to true if the current object is a bulk export report.
Parameters
| value | true current object is a bulk export report. |
|---|
public abstract void setIsDeliveryNotificationAvailable (boolean value)
Set to true if the feature for creating delivery notification is available.
Parameters
| value | true if the feature for creating new email addresses is available. |
|---|
public abstract void setNotificationAddressArg (String value)
The name of the adressId argument
Parameters
| value | the new name for the addressId argument |
|---|
public abstract void setNotificationAddressId (String value)
Sets the value of the current addressId used when creating subscriptions to existing addresses
Parameters
| value | the new addressId |
|---|
public abstract void setNotificationAddressTypeArg (String value)
The name of the adressType argument. The addressType indicates whether to use an existing addresses or a new address list
Parameters
| value | the new name for the addressType argument. |
|---|
public abstract void setNotificationAddresses (SimpleList value)
The global list of addresses to use for this subscription
Parameters
| value | the new global list of addresses |
|---|
public abstract void setNotificationDeviceArg (String value)
The name of the deviceId argument for new addresses.
Parameters
| value | the new deviceId argument name. |
|---|
public abstract void setNotificationDeviceId (String value)
The current deviceId. This is the device used for new addresses
Parameters
| value | the new current deviceId |
|---|
public abstract void setNotificationDevices (SimpleList value)
Sets the global list of devices to use for new addresses
Parameters
| value | the new list of devices. |
|---|
public abstract void setNotificationNewAddressArg (String value)
The name of the newAddress argument.
Parameters
| value | the new newAddress argument name |
|---|
public abstract void setNotificationNewAddressValue (String value)
The value of the address list used when creating subscriptions to new addresses
Parameters
| value | a comma separated list of addresses |
|---|
public abstract void setUseDeliveryNotification (boolean value)
Set to true if delivery notification is currently used.
Parameters
| value | true if delivery notification is currently used. |
|---|
public abstract void setUseDeliveryNotificationArg (String value)
The name of the useDeliveryNotification argument.
Parameters
| value | the new useDeliveryNotification argument name. |
|---|