wt.notify
Class ObjectSubscription

java.lang.Object
  wt.fc.WTObject
      wt.notify.ObjectSubscription

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.AccessControlList, wt.access.AdHocControlled, wt.admin.DomainAdministered, NetFactor, ObjectMappable, Persistable, DisplayIdentification, Ownable

Deprecated. Replaced by NotificationSubscription, NotifySubscriptionRecipient, and NotifySubscriptionTarget.

public class ObjectSubscription
extends WTObject
implements wt.admin.DomainAdministered, Ownable, wt.access.AdHocControlled, Externalizable

The ObjectSubscription class represents subscription requests on Notifiable objects. Each subscription object represents the interest of a single subscriber on an event that may occur to a Notifiable object. The event can be post-filtered by a name-value pair, where name is the name of an attribute and value is the String representation of the value of the attribute. Expiration dates can be associated with subscriptions. The action to be performed upon occurrence of the event depends on the subscriber. If the subscriber is a user, an email message notifying the user of the event is sent. The subscription objects contain attributes to be used when constructing the message (subject, HTML template name and message body).

Use the newObjectSubscription static factory method(s), not the ObjectSubscription constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

NotificationSubscription, NotifySubscriptionRecipient, NotifySubscriptionTarget, Serialized Form

Field Summary

static String	EVENT_KEY Deprecated.
static String	SUBJECT Deprecated.

Method Summary

String	getAttributeValue(String name) Deprecated.
String	getEventKey() Deprecated.
String	getSubject() Deprecated.
Notifiable	getTarget() Deprecated.
protected void	initialize(ObjectSubscription subscription) Deprecated.
static ObjectSubscription	newObjectSubscription() Deprecated.
static ObjectSubscription	newObjectSubscription(ObjectSubscription subscription) Deprecated.
void	setAttributeValue(String name, String value) Deprecated.
void	setEventKey(String a_EventKey) Deprecated.
void	setSubject(String a_Subject) Deprecated.
void	setTarget(Notifiable target) Deprecated.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EVENT_KEY

public static final String EVENT_KEY

Deprecated.

Label for the attribute; Event key.

Supported API: true

See Also:

Constant Field Values

SUBJECT

public static final String SUBJECT

Deprecated.

Label for the attribute; Notification message subject.

Supported API: true

See Also:

Constant Field Values

Method Detail

getEventKey

public String getEventKey()

Deprecated.

Gets the value of the attribute: EVENT_KEY. Event key.

Supported API: true

Returns:

String

setEventKey

public void setEventKey(String a_EventKey)
                 throws WTPropertyVetoException

Deprecated.

Sets the value of the attribute: EVENT_KEY. Event key.

Supported API: true

Parameters:

a_EventKey -

Throws:

WTPropertyVetoException

getSubject

public String getSubject()

Deprecated.

Gets the value of the attribute: SUBJECT. Notification message subject.

Supported API: true

Returns:

String

setSubject

public void setSubject(String a_Subject)
                throws WTPropertyVetoException

Deprecated.

Sets the value of the attribute: SUBJECT. Notification message subject.

Supported API: true

Parameters:

a_Subject -

Throws:

WTPropertyVetoException

newObjectSubscription

public static ObjectSubscription newObjectSubscription(ObjectSubscription subscription)
                                                throws WTException

Deprecated.

Copy constructor. Neither the key nor the reference to the subscriber are copied.

Supported API: true

Parameters:

subscription -

Returns:

ObjectSubscription

Throws:

WTException

initialize

protected void initialize(ObjectSubscription subscription)
                   throws WTException

Deprecated.

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

subscription -

Throws:

WTException

newObjectSubscription

public static ObjectSubscription newObjectSubscription()
                                                throws WTException

Deprecated.

No-arg constructor.

Supported API: true

Returns:

ObjectSubscription

Throws:

WTException

setTarget

public void setTarget(Notifiable target)
               throws WTException

Deprecated.

Sets the target of an object subscription.

Supported API: true

Parameters:

target - target of subscription

Throws:

WTException

getTarget

public Notifiable getTarget()

Deprecated.

Returns the target of an object subscription.

Supported API: true

Returns:

Notifiable

getAttributeValue

public String getAttributeValue(String name)

Deprecated.

Returns the attribute value for the named attribute.

Supported API: true

Parameters:

name - attribute name

Returns:

String

setAttributeValue

public void setAttributeValue(String name,
                              String value)

Deprecated.

Sets an attribute value for the named attribute. If a value was previously set for the named attribute, the old value is replaced.

Supported API: true

Parameters:

name - attribute name

value - String representation of the named attribute's value