Package wt.notify

Class CompositeNotificationSubscription

java.lang.Object
wt.notify.CompositeNotificationSubscription
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
WebCompositeNotificationSubscription
public class CompositeNotificationSubscription extends Object implements Serializable
Contains all the parts that make up a Notification subscription. Subscriptions have three parts that include: 1) a NotificationSubscription object, 2) one or more NotifySubscriptionRecipient objects, and 3) one or more NotifySubscriptionTarget objects.

Use the newCompositeNotificationSubscription static factory method(s), not the CompositeNotificationSubscription 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.

Note that CompositeNotificationSubscription objects are created by Windchill when necessary. Directly creating objects of this class is not supported.

Supported API: true

Extendable: false

See Also:

  • Method Details

    • toString

      public String toString()
      Returns a string representation of the CompositeNotificationSubscription object contents.

      Supported API: true
      Overrides:
      toString in class Object
      Returns:
      String

    • getNotifySubscriptionRecipients

      public WTCollection getNotifySubscriptionRecipients()
      Gets the value of the attribute: notifySubscriptionRecipients; WTCollection containing the recipients for the subscription represented by this CompositeNotificationSubscription object. The recipients contained in the WTCollection are NotifySubscriptionRecipient objects.

      Supported API: true
      Returns:
      WTCollection
      See Also:

    • getNotifySubscriptionTargets

      public WTCollection getNotifySubscriptionTargets()
      Gets the value of the attribute: notifySubscriptionTargets; WTCollection containing the target objects for the subscription represented by this CompositeNotificationSubscription object. The targets contained in the WTCollection are NotifySubscriptionTarget objects.

      Supported API: true
      Returns:
      WTCollection
      See Also:

    • equals

      public boolean equals(Object in_object)
      Determines whether this CompositeNotificationSubscription and the input CompositeNotificationSubscription represent the same persisted notification subscription object. This method only compares the notificationSubscriptionOID attributes to determine whether the two CompositeNotificationSubscription objects represent the same persisted notification subscription object. If the OIDs match, true is returned. If either CompositeNotificationSubscription object represents a subscription that hasn't been persisted, false is returned since an unpersisted subscription won't have a notificationSubscriptionOID.

      Supported API: true
      Overrides:
      equals in class Object
      Parameters:
      in_object - The CompositeNotificationSubscription object to compare to this CompositeNotificationSubscription object. If null is specified, false is returned.
      Returns:
      boolean
      See Also:

    • getNotificationSubscription

      public NotificationSubscription getNotificationSubscription()
      Gets the value of the attribute: notificationSubscription.

      Supported API: true
      Returns:
      NotificationSubscription

    • getNotificationSubscriptionOID

      public ObjectIdentifier getNotificationSubscriptionOID()
      Gets the value of the attribute: notificationSubscriptionOID; ObjectIdentifier for the NotificationSubscription contained in the notificationSubscription attribute. Note if the NotificationSubscription is not persisted, null is returned.

      Supported API: true
      Returns:
      ObjectIdentifier
      See Also:

    • getNotificationSubscriptionRef

      public ObjectReference getNotificationSubscriptionRef() throws WTException
      Gets the value of the attribute: notificationSubscriptionRef; ObjectReference for the NotificationSubscription contained in the notificationSubscription attribute. Note if the NotificationSubscription is not persisted, null is returned.

      Supported API: true
      Returns:
      ObjectReference
      Throws:
      WTException
      See Also:

    • getSubscriptionTargetMetaData

      public CompositeNotificationSubscription.SubscriptionTargetMetaData getSubscriptionTargetMetaData(ObjectReference targetRef)
      Returns the CompositeNotificationSubscription.SubscriptionTargetMetaData object for the input subscription target reference.

      Supported API: true
      Parameters:
      targetRef - The ObjectReference for a subscription target object. This is the target reference contained in one of the CompositeNotificationSubscription's NotifySubscriptionTarget objects NOT a NotifySubscriptionTarget object reference. If null is specified, null is returned. If there is no meta data for this targetRef, null is returned.
      Returns:
      SubscriptionTargetMetaData

    • getSubscriptionTargetMetaDataAttribute

      public Object getSubscriptionTargetMetaDataAttribute(ObjectReference targetRef, CompositeNotificationSubscription.SubscriptionTargetMetaDataAttribute targetMetaDataAttr)
      Returns the specified CompositeSubscription.SubscriptionTargetMetaData attribute for the input subscription target reference.

      Supported API: true
      Parameters:
      targetRef - The ObjectReference for a subscription target object. This is the target reference contained in one of the CompositeNotificationSubscription's NotifySubscriptionTarget objects NOT a NotifySubscriptionTarget object reference. If null is specified, null is returned. If there is no meta data for this targetRef, null is returned.
      targetMetaDataAttr - The meta data attribute to return. Possible values are:
      • SubscriptionTargetMetaDataAttribute.TARGET_DISPLAY_TYPE - The displayable value for the target type. The return object is a String.
      • SubscriptionTargetMetaDataAttribute.TARGET_TYPE - The non-displayable target type value. The return object is a String.
      If null is specified, null is returned.
      Returns:
      Object
      See Also:

    • isSubscriber

      public boolean isSubscriber(ObjectReference subscriberRef) throws WTException
      Determines if the input subscriber reference is one of the subscribers for the subscription represented by this CompositeSubscription. The method compares the input ObjectReference with each NotifySubscriptionRecipient subscriberRef attribute and if a match is found, returns true; otherwise, false is returned.

      Supported API: true
      Parameters:
      subscriberRef - The subcriber reference to look for. If null is specified, false is returned.
      Returns:
      boolean
      Throws:
      WTException

    • isSubscriptionOwnedBy

      public boolean isSubscriptionOwnedBy(ObjectReference subscriberRef) throws WTException
      Determines if the input principal reference is the owner of the subscription represented by this CompositeSubscription (i.e., the owner of the NotificationSubscription object contained in this CompositeSubscription). A return value of true means the input principal reference is the owner of this subscription.

      Supported API: true
      Parameters:
      subscriberRef - Reference to a principal to check if it is the owner of this subscription. If the reference isn't a principal or is null, false is returned.
      Returns:
      boolean
      Throws:
      WTException