com.businessobjects.sdk.plugin.desktop.alertnotification
Interface IAlertNotificationBase

All Known Subinterfaces:

IAlertNotification

public interface IAlertNotificationBase

Provides information about the properties of an alert notification. Alert notifications contain the alert messages and other information received by a user as a result of subscribing to an event.

Since:

4.0

See Also:

IEvent

Field Summary

static java.lang.String	KIND The Kind used to identify this object type.
static java.lang.String	PROGID The ProgID used to identify this object type.

Method Summary

int	getEventID() Returns the SI_ID property of the event that generated this alert notification.
int	getEventSourceID() Returns the SI_ID property of the source object instance that generated this alert notification.
java.lang.String	getEventSourceViewerURL() Returns a URL that can be used to view the source object instance that generated this alert notification.
java.util.List	getMessages() Returns a read-only list of messages for this alert notification.
java.util.Date	getNotificationEventendTime() Returns End time for NotificationEventObject in GMT
java.util.Date	getNotificationEventstartTime() Returns Start time for NotificationEventObject in GMT
IReceivedAlertNotifications	getRecipients() Returns information about the recipients of this alert notification.

Field Detail

KIND

static final java.lang.String KIND

The Kind used to identify this object type.

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

The ProgID used to identify this object type.

See Also:

Constant Field Values

Method Detail

getMessages

java.util.List getMessages()

Returns a read-only list of messages for this alert notification. Attempting to modify the returned list triggers an UnsupportedOperationException exception.

Returns:

A List object that contains the alert messages.

InfoObject properties to query for:

SI_ALERT_MESSAGES

getRecipients

IReceivedAlertNotifications getRecipients()
                                          throws SDKException

Returns information about the recipients of this alert notification.

Returns:

An IReceivedAlertNotifications object that contains information about alert recipients.

Throws:

SDKException

InfoObject properties to query for:

SI_ALERTNOTIFICATION_RECIPIENTS

getEventID

int getEventID()
               throws SDKException

Returns the SI_ID property of the event that generated this alert notification.

Returns:

An int that represents the SI_ID property of the event generated this alert notification.

Throws:

SDKException

InfoObject properties to query for:

SI_ALERTNOTIFICATION_EVENT

getEventSourceID

int getEventSourceID()
                     throws SDKException

Returns the SI_ID property of the source object instance that generated this alert notification. This method returns 0 if the event is not tied to an event source or was not triggered by instance processing.

Returns:

An int that is the SI_ID property of the source object or 0 if no source object exists.

Throws:

SDKException

InfoObject properties to query for:

SI_ALERTNOTIFICATION_EVENTSOURCE

getEventSourceViewerURL

java.lang.String getEventSourceViewerURL()
                                         throws SDKException

Returns a URL that can be used to view the source object instance that generated this alert notification. This method returns null if the event is not tied to an event source or was not triggered by instance processing.

Returns:

A URL that can be used to view the object that generated the alert notification.

Throws:

SDKException

InfoObject properties to query for:

SI_VIEWER_URL

getNotificationEventstartTime

java.util.Date getNotificationEventstartTime()
                                             throws SDKException

Returns Start time for NotificationEventObject in GMT

Returns:

Start time for NotificationEventObject in GMT

Throws:

SDKException

InfoObject properties to query for:

SI_ALERT_STARTTIME

getNotificationEventendTime

java.util.Date getNotificationEventendTime()
                                           throws SDKException

Returns End time for NotificationEventObject in GMT

Returns:

End time for NotificationEventObject in GMT

Throws:

SDKException

InfoObject properties to query for:

SI_ALERT_ENDTIME