wt.notify
Class NotificationRule

java.lang.Object
  wt.fc.WTObject
      wt.fc.Item
          wt.notify.NotificationRule

All Implemented Interfaces:

AccessControlled, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class NotificationRule

extends Item

implements Externalizable

A NotificationRule tells for a class, state and event what are the principals that should be notified. The triple is the rule antecedent and the set of principals is the rule consequent.

Use the newNotificationRule static factory method(s), not the NotificationRule 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: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	NOTIFICATION_SET Label for the attribute; Set of principals associated with the rule (rule consequent).
private NotificationSet	notificationSet
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
private AttributeValueSelector	selector
static String	SELECTOR Label for the attribute; Rule antecedent.
(package private) static long	serialVersionUID
protected static long	VERSION_40_UID

Fields inherited from class wt.fc.Item

VERSION_51_UID

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

NotificationRule()

Method Summary

boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getConceptualClassname() Deprecated.
NotificationSet	getNotificationSet() Gets the value of the attribute: NOTIFICATION_SET.
AttributeValueSelector	getSelector() Gets the value of the attribute: SELECTOR.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(Selector sel) Supports initialization, following construction of an instance.
protected static NotificationRule	newNotificationRule(Selector sel) Constructs rule given a selector.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(NotificationRule thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setNotificationSet(NotificationSet a_NotificationSet) Sets the value of the attribute: NOTIFICATION_SET.
void	setSelector(AttributeValueSelector a_Selector) Sets the value of the attribute: SELECTOR.
String	toString() Returns a string representation of the rule.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.fc.Item

getDomainRef, initialize, isInheritedDomain, readVersion, setDomainRef, setInheritedDomain

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

NOTIFICATION_SET

public static final String NOTIFICATION_SET

Label for the attribute; Set of principals associated with the rule (rule consequent).

Supported API: false

See Also:

Constant Field Values

notificationSet

private NotificationSet notificationSet

SELECTOR

public static final String SELECTOR

Label for the attribute; Rule antecedent. As such contains the domain, the class, the state, the event and attribute-value pairs.

Supported API: false

See Also:

Constant Field Values

selector

private AttributeValueSelector selector

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

VERSION_40_UID

protected static final long VERSION_40_UID

See Also:

Constant Field Values

Constructor Detail

NotificationRule

public NotificationRule()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class Item

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class Item

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(NotificationRule thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class Item

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class Item

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getNotificationSet

public NotificationSet getNotificationSet()

Gets the value of the attribute: NOTIFICATION_SET. Set of principals associated with the rule (rule consequent).

Supported API: false

Returns:

NotificationSet

setNotificationSet

public void setNotificationSet(NotificationSet a_NotificationSet)

Sets the value of the attribute: NOTIFICATION_SET. Set of principals associated with the rule (rule consequent).

Supported API: false

Parameters:

a_NotificationSet -

getSelector

public AttributeValueSelector getSelector()

Gets the value of the attribute: SELECTOR. Rule antecedent. As such contains the domain, the class, the state, the event and attribute-value pairs.

Supported API: false

Returns:

AttributeValueSelector

setSelector

public void setSelector(AttributeValueSelector a_Selector)

Sets the value of the attribute: SELECTOR. Rule antecedent. As such contains the domain, the class, the state, the event and attribute-value pairs.

Supported API: false

Parameters:

a_Selector -

newNotificationRule

protected static NotificationRule newNotificationRule(Selector sel)
                                               throws WTException

Constructs rule given a selector. Not available externally: rules can be created using 'addPolicyRule' method of the policy class.

Supported API: false

Parameters:

sel -

Returns:

NotificationRule

Throws:

WTException

initialize

protected void initialize(Selector sel)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

sel -

Throws:

WTException

toString

public String toString()

Returns a string representation of the rule.

Supported API: false

Overrides:

toString in class WTObject

Returns:

String

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class Item

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class Item

Returns:

int