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

public interface IAlertDeliveryConfigurations

This interface exposes configuration settings for delivery of alert notifications. You can obtain this interface by calling the IAlertingApp#getAlertDeliveryConfigurations method, which returns the global alert notification settings for the system. You can also obtain this interface by calling the IEvent#getAlertDeliveryConfigurationOverride method, which returns the alert notification override settings for a particular event. If this interface applies to global alert notification settings, it will contain email and inbox configuration settings. If this interface applies to an event, it may or may not contain email and inbox configuration settings.

Since:

4.0

See Also:

IEvent, IAlertingApp

Method Summary

IAlertEmailConfiguration	getEmailConfiguration() Returns email delivery configuration settings.
IAlertInboxConfiguration	getInboxConfiguration() Returns inbox delivery configuration settings.
boolean	hasEmailConfiguration() Returns whether or not email configuration settings exist.
boolean	hasInboxConfiguration() Returns whether or not inbox configuration settings exist.
void	removeEmailConfiguration() Removes email configuration settings.
void	removeInboxConfiguration() Removes inbox configuration settings.

Method Detail

hasEmailConfiguration

boolean hasEmailConfiguration()

Returns whether or not email configuration settings exist. Events that override the alert delivery configuration settings might not override email configuration settings. Use this method to check for the presence of email configuration settings before calling IAlertDeliveryConfigurations.getEmailConfiguration(), which creates email delivery configuration settings if none exist.

Returns:

true if email configuration settings exist, false otherwise.

getEmailConfiguration

IAlertEmailConfiguration getEmailConfiguration()

Returns email delivery configuration settings. Calling this method creates email override settings for the event if none exist.

Returns:

An IAlertEmailConfiguration object that contains email delivery configuration settings.

removeEmailConfiguration

void removeEmailConfiguration()

Removes email configuration settings. You may only remove email configuration settings for events. Global email configuration settings are mandatory.

Throws:

java.lang.UnsupportedOperationException - Thrown if this interface applies to global application settings.

hasInboxConfiguration

boolean hasInboxConfiguration()

Returns whether or not inbox configuration settings exist. Events that override the alert delivery configuration settings might not override inbox configuration settings. Use this method to check for the presence of inbox configuration settings before calling IAlertDeliveryConfigurations.getInboxConfiguration(), which creates inbox delivery configuration settings if none exist.

Returns:

true if inbox configuration settings exist, false otherwise.

getInboxConfiguration

IAlertInboxConfiguration getInboxConfiguration()

Returns inbox delivery configuration settings. Calling this method creates inbox override settings for the event if none exist.

Returns:

removeInboxConfiguration

void removeInboxConfiguration()

Removes inbox configuration settings. You may only remove inbox configuration settings for events. Global inbox configuration settings are mandatory.

Throws:

java.lang.UnsupportedOperationException - Thrown if this interface applies to global application settings.