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

All Superinterfaces:

java.lang.Iterable

public interface IReceivedAlertNotifications
extends java.lang.Iterable

This interface exposes information about the recipients of alert notifications. Users will receive alert notifications if they are subscribed to an alert that gets triggered. Recipient information may be retrieved from the alert notification or from the user that receives it.

Since:

4.0

See Also:

com.crystaldecisions.sdk.plugin.desktop.alertnotification.IAlertNotification, IUser

Method Summary

IReceivedAlertNotification	get(int objID) Returns alert notification recipient details.
java.util.Set	getIDs() Returns either alert notification IDs or user IDs.
java.util.Iterator	iterator() Returns an iterator that can be used to iterate over the IReceivedAlertNotification objects in this collection.
boolean	remove(int objID) Removes a subscription.
int	size() Returns the number of recipients.

Method Detail

getIDs

java.util.Set getIDs()

Returns either alert notification IDs or user IDs. If this object was returned by com.crystaldecisions.sdk.plugin.desktop.alertnotification.IAlertNotification#getRecipients, this method returns the IDs of the users that received this alert notification. If this object was returned by IUserBase.getReceivedAlertNotifications(), this method returns the IDs of the alert notifications which this user has received.

Returns:

Set containing the IDs of either the alert notifications or users.

get

IReceivedAlertNotification get(int objID)

Returns alert notification recipient details. If this object was returned by com.crystaldecisions.sdk.plugin.desktop.alertnotification.IAlertNotification#getRecipients, this method returns recipient details to this alert notification for the specified user. If this object was returned by IUserBase.getReceivedAlertNotifications(), this method returns recipient details for this user to the specified alert notification.

Parameters:

objID - Alert notification ID or user ID

Returns:

Recipient details

See Also:

IReceivedAlertNotifications.getIDs()

remove

boolean remove(int objID)

Removes a subscription. If this object was returned by com.crystaldecisions.sdk.plugin.desktop.alertnotification.IAlertNotification#getRecipients, this method deletes this alert notification from the specified user's inbox. If this object was returned by IUserBase.getReceivedAlertNotifications(), this method deletes the specified alert notification from this user's inbox.

Parameters:

objID - Alert notification ID or user ID

Returns:

true if the recipient information was removed successfully, false otherwise

See Also:

IReceivedAlertNotifications.getIDs()

iterator

java.util.Iterator iterator()

Returns an iterator that can be used to iterate over the IReceivedAlertNotification objects in this collection.

Specified by:

iterator in interface java.lang.Iterable

size

int size()

Returns the number of recipients. If this object was returned by com.crystaldecisions.sdk.plugin.desktop.alertnotification.IAlertNotification#getRecipients, returns the number of recipients for this alert notification. If this object was returned by IUserBase.getReceivedAlertNotifications(), returns the number of alert notifications that this user sees.