com.businessobjects.sdk.plugin.desktop.alertingapp
Interface IAlertNotificationCleanup

public interface IAlertNotificationCleanup

Defines when to delete alert notifications from the system. You can configure the system to delete alert notifications after a certain length of time or when the system contains the maximum number of alert notifications.

Since:

4.0

Field Summary

static int

NOT_APPLICABLE Defines that there is no value.

Method Summary

int	getExpiryPeriod() Returns the number of days that an alert notification is stored in the system before it is deleted.
int	getMaximumNotificationCount() Returns the maximum number of alert notifications that may be stored in the system.
void	setExpiryPeriod(int expiryPeriodInDays) Sets the number of days that an alert notification is stored in the system before it is deleted.
void	setMaximumNotificationCount(int maxNotifications) Sets the maximum number of alert notifications that may be stored in the system.

Field Detail

NOT_APPLICABLE

static final int NOT_APPLICABLE

Defines that there is no value.

See Also:

Constant Field Values

Method Detail

getExpiryPeriod

int getExpiryPeriod()

Returns the number of days that an alert notification is stored in the system before it is deleted.

Returns:

The expiry period in days or IAlertNotificationCleanup.NOT_APPLICABLE if no expiry period is set.

See Also:

IAlertNotificationCleanup.setExpiryPeriod(int)

setExpiryPeriod

void setExpiryPeriod(int expiryPeriodInDays)

Sets the number of days that an alert notification is stored in the system before it is deleted. Use a negative value to specify no expiry period.

Parameters:

expiryPeriodInDays - An int that represents the expiry period in days.

See Also:

IAlertNotificationCleanup.getExpiryPeriod()

getMaximumNotificationCount

int getMaximumNotificationCount()

Returns the maximum number of alert notifications that may be stored in the system. When this value is reached, old alert notifications are deleted.

Returns:

The maximum number of alert notifications to store in the system, or IAlertNotificationCleanup.NOT_APPLICABLE if there is no limit.

See Also:

IAlertNotificationCleanup.setMaximumNotificationCount(int)

setMaximumNotificationCount

void setMaximumNotificationCount(int maxNotifications)

Sets the maximum number of alert notifications that may be stored in the system. Use a negative value to specify no limit.

Parameters:

maxNotifications - An int that represents the maximum number of alert notifications to store in the system.

See Also:

IAlertNotificationCleanup.getMaximumNotificationCount()