Package com.microstrategy.web.objects

Interface WebSubscriptionNotification

public interface 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.

Since:

MicroStrategy Web 8.0.0

Method Summary

Modifier and Type	Method	Description
WebSubscriptionAddress	getAddress()	Notification is sent to this address.
SimpleList	getAvailableAddresses()	Returns the list of potential addresses that are available for use with notification
SimpleList	getAvailableDevices()	Returns the list of devices that are available for use for defining notifications
boolean	isEnabled()	returns whether notification is enabled or disabled.
boolean	isEnabledOnParent()	Returns whether the notification is enabled at the parent subscription level.
void	setAddress(WebSubscriptionAddress address)	Defines the address to which the notification should be sent
void	setEnable(boolean enable)	sets the notification as enabled or otherwise.

Method Detail

getAddress

WebSubscriptionAddress getAddress()

Notification is sent to this address.

setAddress

void setAddress(WebSubscriptionAddress address)

Defines the address to which the notification should be sent

Parameters:

address - the address to which notification is sent

getAvailableDevices

SimpleList getAvailableDevices()
                        throws WebObjectsException

Returns the list of devices that are available for use for defining notifications

Returns:

a list of available devices

Throws:

WebObjectsException

getAvailableAddresses

SimpleList getAvailableAddresses()
                          throws WebObjectsException

Returns the list of potential addresses that are available for use with notification

Returns:

the list of available addresses

Throws:

WebObjectsException

isEnabled

boolean isEnabled()

returns whether notification is enabled or disabled.

Since:

MicroStrategy Web 8.1.1

setEnable

void setEnable(boolean enable)

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.

Parameters:

enable -

Since:

MicroStrategy Web 8.1.1

isEnabledOnParent

boolean isEnabledOnParent()

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.

Since:

MicroStrategy Web 9.0.0