com.sapportals.wcm.repository.service.subscription

Interface ISubscriptionAttributes

public interface ISubscriptionAttributes

Represents the customizable attributes of a subscription.

A ISubscriptionAttribute describes:
- notification text that is appended to a notification
- expiry date at which the subscription expires
- next send date of subscription notification
- notification interval between two notifications

ISubscriptionAttributes are:
- specific to the subscription itself and not to the subscription/resources
or subscription/recipients relations
- set-/get-able
The get...() methods for read-only subscription attributes are in ISubscription (getID(), getName(), getOwner()) as well as the resource- and recipient-related methods for the ISubscriptionCondition and IChannel.

Copyright (c) SAP AG

See Also:

ISubscription, IChannel, IResource, ISubscriptionCondition

Method Summary

Date	getExpiryDate() Gets the expiration date for the subscription.
Date	getNextSendDate() Gets the earliest possible date of the next notification.
String	getNotificationsInterval() Gets the condition interval of the notifications.
String	getNotificationText() Gets the additional notification text.
void	setExpiryDate(Date expiryDate) Sets the expiration date for the subscription.
void	setNextSendDate(Date nextSendDate) Sets the earliest possible date for the next notification.
void	setNotificationsInterval(String interval) Sets the condition interval of the notifications.
void	setNotificationText(String text) Sets the nonfiction text.

Method Detail

getNextSendDate

public Date getNextSendDate()

Gets the earliest possible date of the next notification.

The actual time at which to send the next notification depends on when an event is sent by a repository manager or polling is done, and one of these things satisfies a subscription condition.

Returns:

a Date with the earliest timestamp of the next time at which a notification can be sent

setNextSendDate

public void setNextSendDate(Date nextSendDate)

Sets the earliest possible date for the next notification.

The actual time at which to send the next notification depends on when an event is sent by a repository manager or polling is done, and one of these things satisfies a subscription condition.
If nextSendDate is null the actual system time is used.

Parameters:

nextSendDate - a Date with the earliest possible timestamp for the next notification

getExpiryDate

public Date getExpiryDate()

Gets the expiration date for the subscription.

After a subscription has expired, it no longer generates notifications.

Returns:

a Date with the expiration timestamp or null if not defined

setExpiryDate

public void setExpiryDate(Date expiryDate)

Sets the expiration date for the subscription.

After a subscription has expired, it no longer generates notifications.

Parameters:

expiryDate - a Date with the expiration date or null if not defined (no expiry)

getNotificationText

public String getNotificationText()

Gets the additional notification text.

This text is added to a notification that is sent to a recipient.

Returns:

a String with the annotation text that is added to a notification

setNotificationText

public void setNotificationText(String text)

Sets the nonfiction text.

Parameters:

text - a String with the annotation text that is added to a notification

getNotificationsInterval

public String getNotificationsInterval()

Gets the condition interval of the notifications.

Returns:

a String with the notifications interval

setNotificationsInterval

public void setNotificationsInterval(String interval)

Sets the condition interval of the notifications.