| com.microstrategy.web.objects.WebSubscriptionNotification |
This interface defines various methods that support notification of when a subscription is sent. It is typically used to send an email notification of file or print subscription.
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract WebSubscriptionAddress |
getAddress()
Notification is sent to this address.
| ||||||||||
| abstract SimpleList |
getAvailableAddresses()
Returns the list of potential addresses that are available for use
with notification
| ||||||||||
| abstract SimpleList |
getAvailableDevices()
Returns the list of devices that are available for use for defining
notifications
| ||||||||||
| abstract boolean |
isEnabled()
returns whether notification is enabled or disabled.
| ||||||||||
| abstract boolean |
isEnabledOnParent()
Returns whether the notification is enabled at the parent subscription level.
| ||||||||||
| abstract void |
setAddress(WebSubscriptionAddress address)
Defines the address to which the notification should be sent
| ||||||||||
| abstract void |
setEnable(boolean enable)
sets the notification as enabled or otherwise.
| ||||||||||
Returns the list of potential addresses that are available for use with notification
| WebObjectsException |
|---|
Returns the list of devices that are available for use for defining notifications
| WebObjectsException |
|---|
returns whether notification is enabled or disabled.
Returns whether the notification is enabled at the parent subscription level. Only makes sense for a multi-recipient subscription at the
child instance level. For all other cases, this method will return a value of false.
Defines the address to which the notification should be sent
| address | the address to which notification is sent |
|---|
sets the notification as enabled or otherwise. When set to true for single recipient subscriptions,
this setting should be combined with a valid address being set using setAddress(WebSubscriptionAddress). A value of false for single
recipient subscription would disable notification.
For multiple recipient subscriptions, the owner cannot set a notification address but can only disable/enable notifications to the
recipient's default email address and hence this setting is relevant particularly for those cases.