Package wt.notify

Class NotifySubscriptionRecipient

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.notify._NotifySubscriptionRecipient
wt.notify.NotifySubscriptionRecipient
All Implemented Interfaces:
Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, NetFactor, ObjectMappable, Persistable, DisplayIdentification
@GenAsPersistable(superClass=WTObject.class,serializable=EXTERNALIZABLE_BASIC,properties={@GeneratedProperty(name="subscriberRef",type=ObjectReference.class,supportedAPI=PUBLIC,javaDoc="Reference to the recipient object. This is a reference to either a WTUser, a WTGroup, a WTOrganization, or an ObjectSubscriptionListener.",accessors=@PropertyAccessors(getAccess=PRIVATE)),@GeneratedProperty(name="subscriberType",type=int.class,initialValue="NotifySubscriptionRecipient.UNSPECIFIED_SUBSCRIBER_TYPE",javaDoc="Integer that specifies the type of subscriber, either: Principal subscriber or Listener subscriber. Use the NotifySubscriptionRecipient class constants: WTPRINCIPAL_SUBSCRIBER, LISTENER_SUBSCRIBER to specify this value.",accessors=@PropertyAccessors(getAccess=PRIVATE)),@GeneratedProperty(name="addressType",type=int.class,initialValue="NotifySubscriptionRecipient.TO_ADDRESS",supportedAPI=PUBLIC,javaDoc="Integer that specifies how the recipient should be addressed when sending a notification email for this subscription, either: TO, CC, or BCC. Use the NotifySubscriptionRecipient class constants TO_ADDRESS, CC_ADDRESS, and BCC_ADDRESS to specify this value. If not specified, it defaults to TO_ADDRESS.")},foreignKeys=@GeneratedForeignKey(name="NotifySubscriptnRecipntLink",foreignKeyRole=@ForeignKeyRole(name="subscription",type=NotificationSubscription.class,constraints=@PropertyConstraints(required=true)),myRole=@MyRole(name="recipient",cardinality=ONE_TO_MANY,cascade=true)),tableProperties=@TableProperties(compositeIndex1="subscriptionReference.key.id",compositeIndex2="subscriberRef.key.id",compositeIndex3="subscriberRef.key.id + subscriptionReference.key.id",compositeIndex4="subscriptionReference.key.id + subscriberType")) public class NotifySubscriptionRecipient extends _NotifySubscriptionRecipient
Contains the information specific to a notification subscription recipient (also known as a subscriber). Recipients can be WTUsers, WTGroups, WTOrganizations, or ObjectSubscriptionListeners. The attributes contained in this class are the attributes that are unique to a subscription recipient. In addition, this class contains a reference to the NotificationSubscription object the recipient applies to.

A complete subscription consists of a single NotificationSubscription object, one or more NotifySubscriptionRecipient objects, and one or more NotifySubscriptionTarget objects.

Use the newNotifySubscriptionRecipient static factory method(s), not the NotifySubscriptionRecipient 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 NotificationSubscriptionRecipient objects are created by Windchill when a subscription is created. Directly creating objects of this class is not supported.



Supported API: true

Extendable: false

See Also:

  • Field Details

    • TO_ADDRESS

      public static final int TO_ADDRESS
      addressType attribute constant. If addressType is set to TO_ADDRESS, this subscription recipient is addressed as one of the TO users in notification emails sent for the subscription.



      Supported API: true

      See Also:

    • CC_ADDRESS

      public static final int CC_ADDRESS
      addressType attribute constant. If addressType is set to CC_ADDRESS, this subscription recipient is addressed as one of the CC users in notification emails sent for the subscription.



      Supported API: true

      See Also:

    • BCC_ADDRESS

      public static final int BCC_ADDRESS
      addressType attribute constant. If addressType is set to BCC_ADDRESS, this subscription recipient is addressed as one of the BCC users in notification emails sent for the subscription.



      Supported API: true

      See Also:

  • Method Details

    • setAddressType

      public void setAddressType(int a_AddressType) throws WTPropertyVetoException
      Sets the value of the attribute: ADDRESS_TYPE. Integer that specifies how the recipient should be address when sending a notification email for this subscription, either TO, CC, or BCC. Use the NotifySubscriptionRecipient class constants TO_ADDRESS, CC_ADDRESS, BCC_ADDRESS to specify this value.

      Supported API: true
      Overrides:
      setAddressType in class _NotifySubscriptionRecipient
      Parameters:
      a_AddressType -
      Throws:
      WTPropertyVetoException
      See Also:

    • getSubscriberRef

      public ObjectReference getSubscriberRef()
      Gets the value of the attribute: SUBSCRIBER_REF. Reference to the recipient object. This is a reference to either a WTUser, a WTGroup, a WTOrganization or an ObjectSubscriptionListener.

      Supported API: true
      Returns:
      ObjectReference

    • setSubscriberRef

      public void setSubscriberRef(Object a_Subscriber) throws WTPropertyVetoException, WTException
      Sets the value of the attribute: SUBSCRIBER_REF. The attribute is set to the Object Reference of the input subscriber.

      Supported API: true
      Parameters:
      a_Subscriber - The subscriber object. This must be either a WTUser, a WTGroup, a WTOrganization or an ObjectSubscriptionListener object.
      Throws:
      WTPropertyVetoException
      WTException

    • toString

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

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