Package wt.notify

Class ObjectSubscription

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.notify._ObjectSubscription
wt.notify.ObjectSubscription
All Implemented Interfaces:
Externalizable, Serializable, wt.access._AccessControlled, wt.access._AccessControlList, wt.access._AdHocControlled, AccessControlled, wt.access.AccessControlList, AdHocControlled, wt.admin._DomainAdministered, DomainAdministered, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, NetFactor, ObjectMappable, Persistable, DisplayIdentification, wt.ownership._Ownable, wt.ownership.Ownable
@GenAsPersistable(superClass=WTObject.class,interfaces={DomainAdministered.class,wt.ownership.Ownable.class,AdHocControlled.class},versions=8488893113783974719L,properties={@GeneratedProperty(name="targetRef",type=ObjectReference.class,javaDoc="Reference to the target object.",accessors=@PropertyAccessors(setAccess=PROTECTED,setExceptions={})),@GeneratedProperty(name="subscriberRef",type=ObjectReference.class,javaDoc="Reference to the subscriber (user or a object event listener persistable object).",accessors=@PropertyAccessors(setAccess=PROTECTED,setExceptions={})),@GeneratedProperty(name="eventKey",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="Event key."),@GeneratedProperty(name="attrValueMap",type=WTStringMap.class,javaDoc="Name of the attribute; used to post-filter the event: target is checked if attribute value is the same as specified; ignored if null.",accessors=@PropertyAccessors(getAccess=PROTECTED),constraints=@PropertyConstraints(upperLimit=4000)),@GeneratedProperty(name="templateName",type=java.lang.String.class,javaDoc="Name of the template used to create a notification message."),@GeneratedProperty(name="subject",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="Notification message subject."),@GeneratedProperty(name="messageBody",type=java.lang.String.class,javaDoc="Body of the notification message. The body is to be inserted in the message template, if it exists.",constraints=@PropertyConstraints(upperLimit=4000)),@GeneratedProperty(name="expirationTime",type=java.sql.Timestamp.class,javaDoc="Time when the subscription expires; null means that the subscription doesn\'t expire."),@GeneratedProperty(name="subscriptionKey",type=java.lang.String.class,javaDoc="Optional user-defined key used to identify all subscriptions resulting from the same user action (created by call to the server method).",accessors=@PropertyAccessors(setExceptions={}))},tableProperties=@TableProperties(compositeIndex1="targetRef.key.id",compositeIndex2="subscriberRef.key.id + eventKey + thePersistInfo.markForDelete")) public class ObjectSubscription extends _ObjectSubscription
Deprecated.
This class is for pre-R9.0 subscriptions. Replaced in R9.0 by: NotificationSubscription, NotifySubscriptionRecipient, and NotifySubscriptionTarget.
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:

  • Method Details

    • 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