wt.notify
Class NotificationSet

java.lang.Object
  wt.notify.NotificationSet

All Implemented Interfaces:

Externalizable, Serializable, Evolvable

public class NotificationSet
extends Object
implements Serializable, Externalizable, Evolvable

A notification set associates a message with a list of recipients. This class is the "workhorse" of the policy based notification functionality. Message recipients can be users or groups (principals). Groups are resolved to users at the time the event occurs.

Supported API: true

Extendable: false

See Also:

Serialized Form

Method Summary

void	addRecipient(Object recipient) Adds a recipient to the notification set.
String	getMessageBody() Gets the value of the attribute: messageBody; Body of notification message.
EnumeratorVector	getRecipients() Returns an enumeration consisting of references to the recipients.
String	getSubject() Gets the value of the attribute: subject; Notification message subject.
String	getTemplateName() Gets the value of the attribute: templateName; Name of the template used to create notification.
static NotificationSet	newNotificationSet() No-arg constructor.
void	removeAllRecipients() Removes all recipients from the notification set.
void	removeRecipient(Object recipient) Removes a recipient from the notification set.
void	setMessageBody(String a_MessageBody) Sets the value of the attribute: messageBody; Body of notification message.
void	setSubject(String a_Subject) Sets the value of the attribute: subject; Notification message subject.
void	setTemplateName(String a_TemplateName) Sets the value of the attribute: templateName; Name of the template used to create notification.
String	toString() Returns a string representation of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getTemplateName

public String getTemplateName()

Gets the value of the attribute: templateName; Name of the template used to create notification.

Supported API: true

Returns:

String

setTemplateName

public void setTemplateName(String a_TemplateName)
                     throws WTPropertyVetoException

Sets the value of the attribute: templateName; Name of the template used to create notification.

Supported API: true

Parameters:

a_TemplateName -

Throws:

WTPropertyVetoException

getSubject

public String getSubject()

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

Supported API: true

Returns:

String

setSubject

public void setSubject(String a_Subject)
                throws WTPropertyVetoException

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

Supported API: true

Parameters:

a_Subject -

Throws:

WTPropertyVetoException

getMessageBody

public String getMessageBody()

Gets the value of the attribute: messageBody; Body of notification message. The body is to be inserted in message template, if it exists.

Supported API: true

Returns:

String

setMessageBody

public void setMessageBody(String a_MessageBody)
                    throws WTPropertyVetoException

Sets the value of the attribute: messageBody; Body of notification message. The body is to be inserted in message template, if it exists.

Supported API: true

Parameters:

a_MessageBody -

Throws:

WTPropertyVetoException

newNotificationSet

public static NotificationSet newNotificationSet()
                                          throws WTException

No-arg constructor.

Supported API: true

Returns:

NotificationSet

Throws:

WTException

toString

public String toString()

Returns a string representation of the object.

Supported API: true

Overrides:

toString in class Object

Returns:

String

addRecipient

public void addRecipient(Object recipient)
                  throws WTException

Adds a recipient to the notification set. A recipient can be a user or a group (principal). The parameter can be either the object or a reference to the object.

Supported API: true

Parameters:

recipient -

Throws:

WTException

removeRecipient

public void removeRecipient(Object recipient)
                     throws WTException

Removes a recipient from the notification set. A recipient can be a user or a group (principal). The parameter can be either the object or a reference to the object.

Supported API: true

Parameters:

recipient -

Throws:

WTException

removeAllRecipients

public void removeAllRecipients()
                         throws WTException

Removes all recipients from the notification set.

Supported API: true

Throws:

WTException

getRecipients

public EnumeratorVector getRecipients()
                               throws WTException

Returns an enumeration consisting of references to the recipients.

Supported API: true

Returns:

EnumeratorVector

Throws:

WTException