com.businessobjects.sdk.plugin.desktop.common
Interface IAlertSubscription

public interface IAlertSubscription

This interface exposes information about an alert subscription. This interface can either be obtained from an event or from the principal (user or group) that is subscribed to the event. Depending on how this interface was obtained, the IDs used by these methods either represent the SI_ID property of the event or the SI_ID property of the principal subscribed to the event. If this interface was obtained from an event, the ID represents the SI_ID property of the principal subscribed to the event. If the interface was obtained from a principal, the ID represent the SI_ID property of the event that the principal is subscribed to. Use IEventBase.getAlertSubscriptions() to retrieve a collection of IAlertSubscription objects from an event. Use ISystemPrincipal.getAlertSubscriptions() or com.crystaldecisions.sdk.plugin.desktop.user.IUserGroup#getAlertSubscriptions to retrieve a collection of IAlertSubscription objects from a user or usergroup.

Since:

4.0

Nested Class Summary

static interface

IAlertSubscription.CeAlertDeliveryMethod This interface defines constants for the supported alerting delivery methods.

Method Summary

java.util.Set	getDeliveryMethods() Returns the alert notification delivery methods set for this alert subscription.
int	getID() Returns the SI_ID property of the event or the principal subscribed to the event.

Method Detail

getID

int getID()

Returns the SI_ID property of the event or the principal subscribed to the event.

If this interface was obtained from an event, this method returns the SI_ID property of the principal subscribed to the event. If this interface was obtained from a principal, this method returns the SI_ID property of the event that the principal is subscribed to.

Returns:

The SI_ID property of the event, user, or usergroup.

getDeliveryMethods

java.util.Set getDeliveryMethods()

Returns the alert notification delivery methods set for this alert subscription. You can add delivery methods to this set by adding String objects defined by constants from the CeAlertDeliveryMethod class.

Returns:

The set of delivery methods for this alert subscription.

See Also:

IAlertSubscription.CeAlertDeliveryMethod