Package wt.notify

Class _NotifySubscriptionTarget

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.notify._NotifySubscriptionTarget

All Implemented Interfaces:

Externalizable, Serializable, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, NetFactor, ObjectMappable, Persistable, DisplayIdentification

Direct Known Subclasses:

NotifySubscriptionTarget

public abstract class _NotifySubscriptionTarget
extends WTObject
implements Externalizable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTRIBUTE_VALUE_MAP	If a subscription is to apply only when the target object has one or more of its attributes set to a specific value, the attributeValueMap contains these attributes and their corresponding values.
static final String	EVENT	The event that is subscribed to for the target object.
static final String	SUBSCRIBE_ALL_VERSIONS	If the target object is a versioned object, indicates whether the subscription should apply to 1) all iterations of all versions or 2) only to iterations of a single version.
static final String	TARGET_REF	The reference to the subscription target object.
static final String	TARGET_TYPE	The target object type subscribed to.

Method Summary

Modifier and Type	Method	Description
WTStringMap	getAttributeValueMap()	If a subscription is to apply only when the target object has one or more of its attributes set to a specific value, the attributeValueMap contains these attributes and their corresponding values.
String	getEvent()	The event that is subscribed to for the target object.
String	getTargetType()	The target object type subscribed to.
boolean	isSubscribeAllVersions()	If the target object is a versioned object, indicates whether the subscription should apply to 1) all iterations of all versions or 2) only to iterations of a single version.
void	setAttributeValueMap(WTStringMap attributeValueMap)	If a subscription is to apply only when the target object has one or more of its attributes set to a specific value, the attributeValueMap contains these attributes and their corresponding values.
void	setEvent(String event)	The event that is subscribed to for the target object.
void	setSubscribeAllVersions(boolean subscribeAllVersions)	If the target object is a versioned object, indicates whether the subscription should apply to 1) all iterations of all versions or 2) only to iterations of a single version.
void	setTargetType(String targetType)	The target object type subscribed to.

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

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

Field Details

EVENT

public static final String EVENT

The event that is subscribed to for the target object. When the event occurs for the target this subscription fires.

Supported API: true

See Also:

• NotifySubscriptionTarget
• Constant Field Values

TARGET_TYPE

public static final String TARGET_TYPE

The target object type subscribed to. Target object type only applies for subscription targets (the targetRef) that are folder objects or container objects.

Supported API: true

See Also:

• NotifySubscriptionTarget
• Constant Field Values

TARGET_REF

public static final String TARGET_REF

The reference to the subscription target object. Three different types of references can be stored. If the target object is Iterated, the ObjectReference will reference a ControlBranch. If the object is Versioned and the subscribeAllVersions attribure is true, the ObjectReference will reference the target object's Master; if subscribeAllVersions is false the ObjectReference will reference a ControlBranch. Otherwise, the reference will be to the target object itself.

Supported API: true

See Also:

• NotifySubscriptionTarget
• Constant Field Values

ATTRIBUTE_VALUE_MAP

public static final String ATTRIBUTE_VALUE_MAP

If a subscription is to apply only when the target object has one or more of its attributes set to a specific value, the attributeValueMap contains these attributes and their corresponding values. This map maps String attribute names to their corresponding String value. When the subscribed to event occurs for the target object, the subscription won't fire unless these attributes and values match the current values for the target object's corresponding attributes. For example, a subscription could be created for a State Change where the target object's State attribute value has to be Released for the subscription to fire.

Supported API: true

See Also:

• NotifySubscriptionTarget
• Constant Field Values

SUBSCRIBE_ALL_VERSIONS

public static final String SUBSCRIBE_ALL_VERSIONS

If the target object is a versioned object, indicates whether the subscription should apply to 1) all iterations of all versions or 2) only to iterations of a single version. True means the subscription applies to all iterations of all versions. If notspecified, the default value is false.

Supported API: true

See Also:

• NotifySubscriptionTarget
• Constant Field Values

Method Details

getEvent

public String getEvent()

The event that is subscribed to for the target object. When the event occurs for the target this subscription fires.

Supported API: true

See Also:

• NotifySubscriptionTarget

setEvent

public void setEvent(String event)
              throws WTPropertyVetoException

The event that is subscribed to for the target object. When the event occurs for the target this subscription fires.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• NotifySubscriptionTarget

getTargetType

public String getTargetType()

The target object type subscribed to. Target object type only applies for subscription targets (the targetRef) that are folder objects or container objects.

Supported API: true

See Also:

• NotifySubscriptionTarget

setTargetType

public void setTargetType(String targetType)
                   throws WTPropertyVetoException

The target object type subscribed to. Target object type only applies for subscription targets (the targetRef) that are folder objects or container objects.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• NotifySubscriptionTarget

getAttributeValueMap

public WTStringMap getAttributeValueMap()

If a subscription is to apply only when the target object has one or more of its attributes set to a specific value, the attributeValueMap contains these attributes and their corresponding values. This map maps String attribute names to their corresponding String value. When the subscribed to event occurs for the target object, the subscription won't fire unless these attributes and values match the current values for the target object's corresponding attributes. For example, a subscription could be created for a State Change where the target object's State attribute value has to be Released for the subscription to fire.

Supported API: true

See Also:

• NotifySubscriptionTarget

setAttributeValueMap

public void setAttributeValueMap(WTStringMap attributeValueMap)
                          throws WTPropertyVetoException

If a subscription is to apply only when the target object has one or more of its attributes set to a specific value, the attributeValueMap contains these attributes and their corresponding values. This map maps String attribute names to their corresponding String value. When the subscribed to event occurs for the target object, the subscription won't fire unless these attributes and values match the current values for the target object's corresponding attributes. For example, a subscription could be created for a State Change where the target object's State attribute value has to be Released for the subscription to fire.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• NotifySubscriptionTarget

isSubscribeAllVersions

public boolean isSubscribeAllVersions()

If the target object is a versioned object, indicates whether the subscription should apply to 1) all iterations of all versions or 2) only to iterations of a single version. True means the subscription applies to all iterations of all versions. If notspecified, the default value is false.

Supported API: true

See Also:

• NotifySubscriptionTarget

setSubscribeAllVersions

public void setSubscribeAllVersions(boolean subscribeAllVersions)
                             throws WTPropertyVetoException

If the target object is a versioned object, indicates whether the subscription should apply to 1) all iterations of all versions or 2) only to iterations of a single version. True means the subscription applies to all iterations of all versions. If notspecified, the default value is false.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• NotifySubscriptionTarget