Package wt.notify

Class _NotificationSubscription

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.notify._NotificationSubscription
All Implemented Interfaces:
Externalizable, Serializable, wt.access._AccessControlled, wt.access._AccessControlList, wt.access._AdHocControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.AccessControlList, AdHocControlled, wt.access.PolicyAccessControlled, SecurityLabeled, 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, wt.type._TypeManaged, wt.type.TypeManaged
Direct Known Subclasses:
NotificationSubscription
public abstract class _NotificationSubscription extends WTObject implements AdHocControlled, wt.ownership.Ownable, wt.access.PolicyAccessControlled, SecurityLabeled, wt.type.TypeManaged, Externalizable
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    EXPIRATION_TIME
    The expiration time for this subscription.
    static final String
    FROM_USER
    An integer constant to indicate what should be used for the email From user when sending a notification email for this subscription.
    static final String
    MESSAGE
    Additional message text to include in any notification emails sent for this subscription.
    static final String
    NAME
    The subscription name.
    static final String
    SEND_IMMEDIATE
    Notification subscription emails can be sent at the time an event satisfying the subscription occurs or at a scheduled time in digest email format containing all notifications that have occured since the last digest email was sent.
    static final String
    SUBJECT
    The email subject to include in any notification emails sent for this subscription.

    Fields inherited from class wt.fc._WTObject

    CREATE_TIMESTAMP, MODIFY_TIMESTAMP

    Fields inherited from interface wt.access._AdHocControlled

    ENTRY_SET

    Fields inherited from interface wt.fc.adminlock._AdministrativelyLockable

    ADMINISTRATIVE_LOCK

    Fields inherited from interface wt.admin._DomainAdministered

    DOMAIN_REF, INHERITED_DOMAIN

    Fields inherited from interface wt.ownership._Ownable

    OWNERSHIP

    Fields inherited from interface wt.fc._Persistable

    PERSIST_INFO

    Fields inherited from interface wt.access._SecurityLabeled

    SECURITY_LABELS

    Fields inherited from interface wt.identity.DisplayIdentification

    DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

    Fields inherited from interface wt.fc.Persistable

    IDENTITY, TYPE

    Fields inherited from interface wt.access.SecurityLabeled

    SECURITY_LABELS_INTERNAL_VALUE

  • Method Summary

    Modifier and Type
    Method
    Description
    Timestamp
    getExpirationTime()
    The expiration time for this subscription.
    int
    getFromUser()
    An integer constant to indicate what should be used for the email From user when sending a notification email for this subscription.
    String
    getMessage()
    Additional message text to include in any notification emails sent for this subscription.
    String
    getName()
    The subscription name.
    String
    getSubject()
    The email subject to include in any notification emails sent for this subscription.
    boolean
    isSendImmediate()
    Notification subscription emails can be sent at the time an event satisfying the subscription occurs or at a scheduled time in digest email format containing all notifications that have occured since the last digest email was sent.
    void
    setExpirationTime(Timestamp expirationTime)
    The expiration time for this subscription.
    void
    setFromUser(int fromUser)
    An integer constant to indicate what should be used for the email From user when sending a notification email for this subscription.
    void
    setMessage(String message)
    Additional message text to include in any notification emails sent for this subscription.
    void
    setName(String name)
    The subscription name.
    void
    setSendImmediate(boolean sendImmediate)
    Notification subscription emails can be sent at the time an event satisfying the subscription occurs or at a scheduled time in digest email format containing all notifications that have occured since the last digest email was sent.
    void
    setSubject(String subject)
    The email subject to include in any notification emails sent for this subscription.

    Methods inherited from class wt.fc.WTObject

    checkAttributes, duplicate, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, initialize, toString

    Methods inherited from class wt.fc._WTObject

    equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfo

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface wt.fc._Persistable

    getPersistInfo, setPersistInfo

    Methods inherited from interface wt.fc.Persistable

    checkAttributes, getIdentity

  • Field Details

    • NAME

      public static final String NAME
      The subscription name. Subscriptions are not required to have names. This optional attribute is provided in case users want to specify a meaningful name for a subscription.

      Supported API: true

      See Also:

    • FROM_USER

      public static final String FROM_USER
      An integer constant to indicate what should be used for the email From user when sending a notification email for this subscription. Possible values are:
      • NotificationSubscription.INITIATOR_FROM_USER,
      • NotificationSubscription.OWNER_FROM_USER, or
      • NotificationSubscription.SYSTEM_FROM_USER
      See the class constants javadoc for a description of each. This attribute is optional. If not specified, it defaults to NotificationSubscription.OWNER_FROM_USER.

      Supported API: true

      See Also:

    • SUBJECT

      public static final String SUBJECT
      The email subject to include in any notification emails sent for this subscription. This attribute is optional; if not specified, default text is generated for the subject whenever an email is sent for this subscription.

      Supported API: true

      See Also:

    • MESSAGE

      public static final String MESSAGE
      Additional message text to include in any notification emails sent for this subscription. This attribute is optitonal; if not specified, no additional message text is included in the email body

      Supported API: true

      See Also:

    • EXPIRATION_TIME

      public static final String EXPIRATION_TIME
      The expiration time for this subscription. When the expiration time is reached the subscription is deleted. This attribute is optional; if not specified, the subscription never expires.

      Supported API: true

      See Also:

    • SEND_IMMEDIATE

      public static final String SEND_IMMEDIATE
      Notification subscription emails can be sent at the time an event satisfying the subscription occurs or at a scheduled time in digest email format containing all notifications that have occured since the last digest email was sent. This attribute indicates whether notification emails for this subscription should be sent immediately or sent in a scheduled notification digest email. True means emails should be sent immediately for this subscription. This attribute is optitonal; IF NOT SPECIFIED, IT DEFAULTS TO FALSE.

      Supported API: true

      See Also:

  • Method Details

    • getName

      public String getName()
      The subscription name. Subscriptions are not required to have names. This optional attribute is provided in case users want to specify a meaningful name for a subscription.

      Supported API: true

      See Also:

    • setName

      public void setName(String name) throws WTPropertyVetoException
      The subscription name. Subscriptions are not required to have names. This optional attribute is provided in case users want to specify a meaningful name for a subscription.

      Supported API: true

      Throws:
      WTPropertyVetoException
      See Also:

    • getFromUser

      public int getFromUser()
      An integer constant to indicate what should be used for the email From user when sending a notification email for this subscription. Possible values are:
      • NotificationSubscription.INITIATOR_FROM_USER,
      • NotificationSubscription.OWNER_FROM_USER, or
      • NotificationSubscription.SYSTEM_FROM_USER
      See the class constants javadoc for a description of each. This attribute is optional. If not specified, it defaults to NotificationSubscription.OWNER_FROM_USER.

      Supported API: true

      See Also:

    • setFromUser

      public void setFromUser(int fromUser) throws WTPropertyVetoException
      An integer constant to indicate what should be used for the email From user when sending a notification email for this subscription. Possible values are:
      • NotificationSubscription.INITIATOR_FROM_USER,
      • NotificationSubscription.OWNER_FROM_USER, or
      • NotificationSubscription.SYSTEM_FROM_USER
      See the class constants javadoc for a description of each. This attribute is optional. If not specified, it defaults to NotificationSubscription.OWNER_FROM_USER.

      Supported API: true

      Throws:
      WTPropertyVetoException
      See Also:

    • getSubject

      public String getSubject()
      The email subject to include in any notification emails sent for this subscription. This attribute is optional; if not specified, default text is generated for the subject whenever an email is sent for this subscription.

      Supported API: true

      See Also:

    • setSubject

      public void setSubject(String subject) throws WTPropertyVetoException
      The email subject to include in any notification emails sent for this subscription. This attribute is optional; if not specified, default text is generated for the subject whenever an email is sent for this subscription.

      Supported API: true

      Throws:
      WTPropertyVetoException
      See Also:

    • getMessage

      public String getMessage()
      Additional message text to include in any notification emails sent for this subscription. This attribute is optitonal; if not specified, no additional message text is included in the email body

      Supported API: true

      See Also:

    • setMessage

      public void setMessage(String message) throws WTPropertyVetoException
      Additional message text to include in any notification emails sent for this subscription. This attribute is optitonal; if not specified, no additional message text is included in the email body

      Supported API: true

      Throws:
      WTPropertyVetoException
      See Also:

    • getExpirationTime

      public Timestamp getExpirationTime()
      The expiration time for this subscription. When the expiration time is reached the subscription is deleted. This attribute is optional; if not specified, the subscription never expires.

      Supported API: true

      See Also:

    • setExpirationTime

      public void setExpirationTime(Timestamp expirationTime) throws WTPropertyVetoException
      The expiration time for this subscription. When the expiration time is reached the subscription is deleted. This attribute is optional; if not specified, the subscription never expires.

      Supported API: true

      Throws:
      WTPropertyVetoException
      See Also:

    • isSendImmediate

      public boolean isSendImmediate()
      Notification subscription emails can be sent at the time an event satisfying the subscription occurs or at a scheduled time in digest email format containing all notifications that have occured since the last digest email was sent. This attribute indicates whether notification emails for this subscription should be sent immediately or sent in a scheduled notification digest email. True means emails should be sent immediately for this subscription. This attribute is optitonal; IF NOT SPECIFIED, IT DEFAULTS TO FALSE.

      Supported API: true

      See Also:

    • setSendImmediate

      public void setSendImmediate(boolean sendImmediate) throws WTPropertyVetoException
      Notification subscription emails can be sent at the time an event satisfying the subscription occurs or at a scheduled time in digest email format containing all notifications that have occured since the last digest email was sent. This attribute indicates whether notification emails for this subscription should be sent immediately or sent in a scheduled notification digest email. True means emails should be sent immediately for this subscription. This attribute is optitonal; IF NOT SPECIFIED, IT DEFAULTS TO FALSE.

      Supported API: true

      Throws:
      WTPropertyVetoException
      See Also: