wt.notify
Class ObjectSubscription

java.lang.Object
  wt.fc.WTObject
      wt.notify.ObjectSubscription

All Implemented Interfaces:

AccessControlled, AccessControlList, AdHocControlled, DisplayIdentification, DomainAdministered, Externalizable, NetFactor, ObjectMappable, Ownable, Persistable, Serializable

public class ObjectSubscription

extends WTObject

implements DomainAdministered, Ownable, AdHocControlled, Externalizable

The ObjectSubscription class represents subscription requests on Notifiable objects. Each subscription object represents the interest of a single subscriber on an event that may occur to a Notifiable object. The event can be post-filtered by a name-value pair, where name is the name of an attribute and value is the String representation of the value of the attribute. Expiration dates can be associated with subscriptions. The action to be performed upon occurrence of the event depends on the subscriber. If the subscriber is a user, an email message notifying the user of the event is sent. The subscription objects contain attributes to be used when constructing the message (subject, HTML template name and message body).

Use the newObjectSubscription static factory method(s), not the ObjectSubscription 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: true

Extendable: false

See Also:

Serialized Form

Field Summary

protected static String	ATTR_VALUE_MAP Label for the attribute; Name of the attribute; used to post-filter the event: target is checked if attribute value is the same as specified; ignored if null.
private static int	ATTR_VALUE_MAP_UPPER_LIMIT
private WTStringMap	attrValueMap
private static String	CLASSNAME
private AdminDomainRef	domainRef
private AclEntrySet	entrySet
static String	EVENT_KEY Label for the attribute; Event key.
private static int	EVENT_KEY_UPPER_LIMIT
private String	eventKey
static String	EXPIRATION_TIME Label for the attribute; Time when the subscription expires; null means that the subscription doesn't expire.
private Timestamp	expirationTime
static long	EXTERNALIZATION_VERSION_UID
private boolean	inheritedDomain
static String	MESSAGE_BODY Label for the attribute; Body of the notification message.
private static int	MESSAGE_BODY_UPPER_LIMIT
private String	messageBody
protected static long	OLD_FORMAT_VERSION_UID
private Ownership	ownership
private static String	RESOURCE
(package private) static long	serialVersionUID
private String	subject
static String	SUBJECT Label for the attribute; Notification message subject.
private static int	SUBJECT_UPPER_LIMIT
static String	SUBSCRIBER_REF Label for the attribute; Reference to the subscriber (user or a object event listener persistable object).
private ObjectReference	subscriberRef
static String	SUBSCRIPTION_KEY Label for the attribute; Optional user-defined key used to identify all subscriptions resulting from the same user action (created by call to the server method).
private static int	SUBSCRIPTION_KEY_UPPER_LIMIT
private String	subscriptionKey
static String	TARGET_REF Label for the attribute; Reference to the target object.
private ObjectReference	targetRef
static String	TEMPLATE_NAME Label for the attribute; Name of the template used to create a notification message.
private static int	TEMPLATE_NAME_UPPER_LIMIT
private String	templateName
private static boolean	VERBOSE_EXECUTION

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.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.access.AdHocControlled

ENTRY_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

ObjectSubscription()

Method Summary

private void	attrValueMapValidate(WTStringMap a_AttrValueMap)
boolean	checkAttributeValues(Object object) Determines whether the object passed as argument matches the subscription, as far as attribute values are concerned.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private void	eventKeyValidate(String a_EventKey)
private String	eventToString(String event) Returns just the name of the event.
Enumeration	getAttributeNames() Returns an enumeration containing all attribute names.
String	getAttributeValue(String name) Returns the attribute value for the named attribute.
protected WTStringMap	getAttrValueMap() Gets the value of the attribute: ATTR_VALUE_MAP.
String	getConceptualClassname() Deprecated.
AdminDomainRef	getDomainRef() Gets the object for the association that plays role: DOMAIN_REF.
AclEntrySet	getEntrySet() Gets the value of the attribute: ENTRY_SET.
String	getEventKey() Gets the value of the attribute: EVENT_KEY.
Timestamp	getExpirationTime() Gets the value of the attribute: EXPIRATION_TIME.
String	getMessageBody() Gets the value of the attribute: MESSAGE_BODY.
Ownership	getOwnership() Gets the object for the association that plays role: OWNERSHIP.
String	getSubject() Gets the value of the attribute: SUBJECT.
ObjectReference	getSubscriberRef() Gets the value of the attribute: SUBSCRIBER_REF.
String	getSubscriptionKey() Gets the value of the attribute: SUBSCRIPTION_KEY.
Notifiable	getTarget() Returns the target of an object subscription.
ObjectReference	getTargetRef() Gets the value of the attribute: TARGET_REF.
String	getTemplateName() Gets the value of the attribute: TEMPLATE_NAME.
boolean	hasAttributes() Returns 'true' if there are attribute-value pairs defined; 'false' otherwise.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private String	idToString(ObjectIdentifier id) Returns just the class name and oid.
protected void	initialize() Supports initialization, following construction of an instance.
protected void	initialize(ObjectSubscription subscription) Supports initialization, following construction of an instance.
boolean	isEquivalent(ObjectSubscription subscription) Returns true if both subscriptions have the same type of subscriber (either a user reference or an object listener reference) and have the same target object, event, subject, message body and template.
boolean	isInheritedDomain() Gets the value of the attribute: INHERITED_DOMAIN.
private void	messageBodyValidate(String a_MessageBody)
static ObjectSubscription	newObjectSubscription() No-arg constructor.
static ObjectSubscription	newObjectSubscription(ObjectSubscription subscription) Copy constructor.
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(ObjectSubscription thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	removeAttribute(String name) Removes attribute given its name.
void	setAttributeValue(String name, String value) Sets an attribute value for the named attribute.
protected void	setAttrValueMap(WTStringMap a_AttrValueMap) Sets the value of the attribute: ATTR_VALUE_MAP.
void	setDomainRef(AdminDomainRef a_DomainRef) Sets the object for the association that plays role: DOMAIN_REF.
void	setEntrySet(AclEntrySet a_EntrySet) Sets the value of the attribute: ENTRY_SET.
void	setEventKey(String a_EventKey) Sets the value of the attribute: EVENT_KEY.
void	setExpirationTime(Timestamp a_ExpirationTime) Sets the value of the attribute: EXPIRATION_TIME.
void	setInheritedDomain(boolean a_InheritedDomain) Sets the value of the attribute: INHERITED_DOMAIN.
void	setMessageBody(String a_MessageBody) Sets the value of the attribute: MESSAGE_BODY.
void	setOwnership(Ownership a_Ownership) Sets the object for the association that plays role: OWNERSHIP.
void	setSubject(String a_Subject) Sets the value of the attribute: SUBJECT.
protected void	setSubscriberRef(ObjectReference a_SubscriberRef) Sets the value of the attribute: SUBSCRIBER_REF.
void	setSubscriptionKey(String a_SubscriptionKey) Sets the value of the attribute: SUBSCRIPTION_KEY.
void	setTarget(Notifiable target) Sets the target of an object subscription.
protected void	setTargetRef(ObjectReference a_TargetRef) Sets the value of the attribute: TARGET_REF.
void	setTemplateName(String a_TemplateName) Sets the value of the attribute: TEMPLATE_NAME.
private void	subjectValidate(String a_Subject)
private void	templateNameValidate(String a_TemplateName)
String	toString() Returns a string representation of the object subscription object.
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.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

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

TARGET_REF

public static final String TARGET_REF

Label for the attribute; Reference to the target object.

Supported API: false

See Also:

Constant Field Values

targetRef

private ObjectReference targetRef

SUBSCRIBER_REF

public static final String SUBSCRIBER_REF

Label for the attribute; Reference to the subscriber (user or a object event listener persistable object).

Supported API: false

See Also:

Constant Field Values

subscriberRef

private ObjectReference subscriberRef

EVENT_KEY

public static final String EVENT_KEY

Label for the attribute; Event key.

Supported API: true

See Also:

Constant Field Values

EVENT_KEY_UPPER_LIMIT

private static int EVENT_KEY_UPPER_LIMIT

eventKey

private String eventKey

ATTR_VALUE_MAP

protected static final String ATTR_VALUE_MAP

Label for the attribute; Name of the attribute; used to post-filter the event: target is checked if attribute value is the same as specified; ignored if null.

Supported API: false

See Also:

Constant Field Values

ATTR_VALUE_MAP_UPPER_LIMIT

private static int ATTR_VALUE_MAP_UPPER_LIMIT

attrValueMap

private WTStringMap attrValueMap

TEMPLATE_NAME

public static final String TEMPLATE_NAME

Label for the attribute; Name of the template used to create a notification message.

Supported API: false

See Also:

Constant Field Values

TEMPLATE_NAME_UPPER_LIMIT

private static int TEMPLATE_NAME_UPPER_LIMIT

templateName

private String templateName

SUBJECT

public static final String SUBJECT

Label for the attribute; Notification message subject.

Supported API: true

See Also:

Constant Field Values

SUBJECT_UPPER_LIMIT

private static int SUBJECT_UPPER_LIMIT

subject

private String subject

MESSAGE_BODY

public static final String MESSAGE_BODY

Label for the attribute; Body of the notification message. The body is to be inserted in the message template, if it exists.

Supported API: false

See Also:

Constant Field Values

MESSAGE_BODY_UPPER_LIMIT

private static int MESSAGE_BODY_UPPER_LIMIT

messageBody

private String messageBody

EXPIRATION_TIME

public static final String EXPIRATION_TIME

Label for the attribute; Time when the subscription expires; null means that the subscription doesn't expire.

Supported API: false

See Also:

Constant Field Values

expirationTime

private Timestamp expirationTime

SUBSCRIPTION_KEY

public static final String SUBSCRIPTION_KEY

Label for the attribute; Optional user-defined key used to identify all subscriptions resulting from the same user action (created by call to the server method).

Supported API: false

See Also:

Constant Field Values

SUBSCRIPTION_KEY_UPPER_LIMIT

private static int SUBSCRIPTION_KEY_UPPER_LIMIT

subscriptionKey

private String subscriptionKey

inheritedDomain

private boolean inheritedDomain

domainRef

private AdminDomainRef domainRef

ownership

private Ownership ownership

entrySet

private AclEntrySet entrySet

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

VERBOSE_EXECUTION

private static boolean VERBOSE_EXECUTION

Constructor Detail

ObjectSubscription

public ObjectSubscription()

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 WTObject

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 WTObject

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ObjectSubscription 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 WTObject

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 WTObject

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

getTargetRef

public ObjectReference getTargetRef()

Gets the value of the attribute: TARGET_REF. Reference to the target object.

Supported API: false

Returns:

ObjectReference

setTargetRef

protected void setTargetRef(ObjectReference a_TargetRef)

Sets the value of the attribute: TARGET_REF. Reference to the target object.

Supported API: false

Parameters:

a_TargetRef -

getSubscriberRef

public ObjectReference getSubscriberRef()

Gets the value of the attribute: SUBSCRIBER_REF. Reference to the subscriber (user or a object event listener persistable object).

Supported API: false

Returns:

ObjectReference

setSubscriberRef

protected void setSubscriberRef(ObjectReference a_SubscriberRef)

Sets the value of the attribute: SUBSCRIBER_REF. Reference to the subscriber (user or a object event listener persistable object).

Supported API: false

Parameters:

a_SubscriberRef -

getEventKey

public String getEventKey()

Gets the value of the attribute: EVENT_KEY. Event key.

Supported API: true

Returns:

String

setEventKey

public void setEventKey(String a_EventKey)
                 throws WTPropertyVetoException

Sets the value of the attribute: EVENT_KEY. Event key.

Supported API: true

Parameters:

a_EventKey -

Throws:

WTPropertyVetoException

eventKeyValidate

private void eventKeyValidate(String a_EventKey)
                       throws WTPropertyVetoException

Parameters:

a_EventKey -

Throws:

WTPropertyVetoException

getAttrValueMap

protected WTStringMap getAttrValueMap()

Gets the value of the attribute: ATTR_VALUE_MAP. Name of the attribute; used to post-filter the event: target is checked if attribute value is the same as specified; ignored if null.

Supported API: false

Returns:

WTStringMap

setAttrValueMap

protected void setAttrValueMap(WTStringMap a_AttrValueMap)
                        throws WTPropertyVetoException

Sets the value of the attribute: ATTR_VALUE_MAP. Name of the attribute; used to post-filter the event: target is checked if attribute value is the same as specified; ignored if null.

Supported API: false

Parameters:

a_AttrValueMap -

Throws:

WTPropertyVetoException

attrValueMapValidate

private void attrValueMapValidate(WTStringMap a_AttrValueMap)
                           throws WTPropertyVetoException

Parameters:

a_AttrValueMap -

Throws:

WTPropertyVetoException

getTemplateName

public String getTemplateName()

Gets the value of the attribute: TEMPLATE_NAME. Name of the template used to create a notification message.

Supported API: false

Returns:

String

setTemplateName

public void setTemplateName(String a_TemplateName)
                     throws WTPropertyVetoException

Sets the value of the attribute: TEMPLATE_NAME. Name of the template used to create a notification message.

Supported API: false

Parameters:

a_TemplateName -

Throws:

WTPropertyVetoException

templateNameValidate

private void templateNameValidate(String a_TemplateName)
                           throws WTPropertyVetoException

Parameters:

a_TemplateName -

Throws:

WTPropertyVetoException

getSubject

public String getSubject()

Gets the value of the attribute: SUBJECT. Notification message subject.

Supported API: true

Returns:

String

setSubject

public void setSubject(String a_Subject)
                throws WTPropertyVetoException

Sets the value of the attribute: SUBJECT. Notification message subject.

Supported API: true

Parameters:

a_Subject -

Throws:

WTPropertyVetoException

subjectValidate

private void subjectValidate(String a_Subject)
                      throws WTPropertyVetoException

Parameters:

a_Subject -

Throws:

WTPropertyVetoException

getMessageBody

public String getMessageBody()

Gets the value of the attribute: MESSAGE_BODY. Body of the notification message. The body is to be inserted in the message template, if it exists.

Supported API: false

Returns:

String

setMessageBody

public void setMessageBody(String a_MessageBody)
                    throws WTPropertyVetoException

Sets the value of the attribute: MESSAGE_BODY. Body of the notification message. The body is to be inserted in the message template, if it exists.

Supported API: false

Parameters:

a_MessageBody -

Throws:

WTPropertyVetoException

messageBodyValidate

private void messageBodyValidate(String a_MessageBody)
                          throws WTPropertyVetoException

Parameters:

a_MessageBody -

Throws:

WTPropertyVetoException

getExpirationTime

public Timestamp getExpirationTime()

Gets the value of the attribute: EXPIRATION_TIME. Time when the subscription expires; null means that the subscription doesn't expire.

Supported API: false

Returns:

Timestamp

setExpirationTime

public void setExpirationTime(Timestamp a_ExpirationTime)
                       throws WTPropertyVetoException

Sets the value of the attribute: EXPIRATION_TIME. Time when the subscription expires; null means that the subscription doesn't expire.

Supported API: false

Parameters:

a_ExpirationTime -

Throws:

WTPropertyVetoException

getSubscriptionKey

public String getSubscriptionKey()

Gets the value of the attribute: SUBSCRIPTION_KEY. Optional user-defined key used to identify all subscriptions resulting from the same user action (created by call to the server method).

Supported API: false

Returns:

String

setSubscriptionKey

public void setSubscriptionKey(String a_SubscriptionKey)

Sets the value of the attribute: SUBSCRIPTION_KEY. Optional user-defined key used to identify all subscriptions resulting from the same user action (created by call to the server method).

Supported API: false

Parameters:

a_SubscriptionKey -

newObjectSubscription

public static ObjectSubscription newObjectSubscription(ObjectSubscription subscription)
                                                throws WTException

Copy constructor. Neither the key nor the reference to the subscriber are copied.

Supported API: true

Parameters:

subscription -

Returns:

ObjectSubscription

Throws:

WTException

initialize

protected void initialize(ObjectSubscription subscription)
                   throws WTException

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

Supported API: true

Parameters:

subscription -

Throws:

WTException

newObjectSubscription

public static ObjectSubscription newObjectSubscription()
                                                throws WTException

No-arg constructor.

Supported API: true

Returns:

ObjectSubscription

Throws:

WTException

setTarget

public void setTarget(Notifiable target)
               throws WTException

Sets the target of an object subscription.

Supported API: true

Parameters:

target - target of subscription

Throws:

WTException

getTarget

public Notifiable getTarget()

Returns the target of an object subscription.

Supported API: true

Returns:

Notifiable

toString

public String toString()

Returns a string representation of the object subscription object.

Supported API: false

Overrides:

toString in class WTObject

Returns:

String

isEquivalent

public boolean isEquivalent(ObjectSubscription subscription)

Returns true if both subscriptions have the same type of subscriber (either a user reference or an object listener reference) and have the same target object, event, subject, message body and template. Equivalent subscriptions for user subscribers result in the same message being sent.

Supported API: false

Parameters:

subscription -

Returns:

boolean

getAttributeValue

public String getAttributeValue(String name)

Returns the attribute value for the named attribute.

Supported API: true

Parameters:

name - attribute name

Returns:

String

setAttributeValue

public void setAttributeValue(String name,
                              String value)

Sets an attribute value for the named attribute. If a value was previously set for the named attribute, the old value is replaced.

Supported API: true

Parameters:

name - attribute name

value - String representation of the named attribute's value

removeAttribute

public void removeAttribute(String name)

Removes attribute given its name. Nothing happens if attribute doesn't belong to selector.

Supported API: false

Parameters:

name -

getAttributeNames

public Enumeration getAttributeNames()

Returns an enumeration containing all attribute names.

Supported API: false

Returns:

Enumeration

hasAttributes

public boolean hasAttributes()

Returns 'true' if there are attribute-value pairs defined; 'false' otherwise.

Supported API: false

Returns:

boolean

checkAttributeValues

public boolean checkAttributeValues(Object object)
                             throws WTException

Determines whether the object passed as argument matches the subscription, as far as attribute values are concerned. Returns 'true' if the values of the attribute objects are the same as the values of the attributes in the subscription, for every attribute in the subscription; returns 'false' otherwise.

Supported API: false

Parameters:

object -

Returns:

boolean

Throws:

WTException

isInheritedDomain

public boolean isInheritedDomain()

Gets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

isInheritedDomain in interface DomainAdministered

Returns:

boolean

setInheritedDomain

public void setInheritedDomain(boolean a_InheritedDomain)
                        throws WTPropertyVetoException

Sets the value of the attribute: INHERITED_DOMAIN. A boolean indicating whether the administrative domain is inherited. If the value is true, the domain is inherited from a parent object.

Supported API: false

Specified by:

setInheritedDomain in interface DomainAdministered

Parameters:

a_InheritedDomain -

Throws:

WTPropertyVetoException

getDomainRef

public AdminDomainRef getDomainRef()

Gets the object for the association that plays role: DOMAIN_REF.

Supported API: false

Specified by:

getDomainRef in interface DomainAdministered

Returns:

AdminDomainRef

setDomainRef

public void setDomainRef(AdminDomainRef a_DomainRef)

Sets the object for the association that plays role: DOMAIN_REF.

Supported API: false

Specified by:

setDomainRef in interface DomainAdministered

Parameters:

a_DomainRef -

getOwnership

public Ownership getOwnership()

Gets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

getOwnership in interface Ownable

Returns:

Ownership

setOwnership

public void setOwnership(Ownership a_Ownership)

Sets the object for the association that plays role: OWNERSHIP. The persistent state for an Ownable object is maintained via the Ownership object. Access to information for the Ownership object should be done via methods on the OwnershipHelper.

Supported API: false

Specified by:

setOwnership in interface Ownable

Parameters:

a_Ownership -

getEntrySet

public AclEntrySet getEntrySet()

Gets the value of the attribute: ENTRY_SET.

Supported API: false

Specified by:

getEntrySet in interface AdHocControlled

Returns:

AclEntrySet

setEntrySet

public void setEntrySet(AclEntrySet a_EntrySet)

Sets the value of the attribute: ENTRY_SET.

Supported API: false

Specified by:

setEntrySet in interface AdHocControlled

Parameters:

a_EntrySet -

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 WTObject

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 WTObject

Returns:

int

initialize

protected void initialize()
                   throws WTException

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

Overrides:

initialize in class WTObject

Throws:

WTException

eventToString

private String eventToString(String event)

Returns just the name of the event.

idToString

private String idToString(ObjectIdentifier id)

Returns just the class name and oid.