Package wt.fc

Class IdentificationObject

java.lang.Object

wt.fc._IdentificationObject

wt.fc.IdentificationObject

All Implemented Interfaces:

Externalizable, Serializable, wt.fc._NetFactor, NetFactor

Direct Known Subclasses:

wt.folder._CabinetIdentity, wt.change2._ChangeIdentificationObject, wt.eff._EffConfigurationItemIdentificationObject, _EPMDocumentMasterIdentity, com.ptc.windchill.esi.tgt._ESITargetIdentity, com.ptc.core.managedcollection._ManagedCollectionIdentity, wt.mpm.configuration._MPMConfRecipeMasterIdentity, _MPMControlQualityMasterIdentity, _MPMMfgProcessMasterIdentity, _MPMMfgStandardGroupMasterIdentity, _MPMOperationMasterIdentity, _MPMProcessPlanMasterIdentity, _MPMSequenceMasterIdentity, wt.maturity._PromotionIdentificationObject, _RegulatorySubmissionMasterIdentity, wt.folder._SubFolderIdentity, wt.folder._SubFolderLinkIdentity, _WTContainerIdentity, _WTDocumentMasterIdentity, _WTPartMasterIdentity

@GenAsUnPersistable(interfaces={NetFactor.class,java.io.Externalizable.class},
                    extendable=true,
                    versions=957977401221134810L)
public abstract class IdentificationObject
extends wt.fc._IdentificationObject

The IdentificationObject is an abstract class that encapsulates information about the identity of a single class or a set of classes. It contains methods to store, change and delete associated semantic key. It also provides default implementations for all but two methods: 'setToObject' and 'getIdentity'. The default methods use a default semantic key class. A customized semantic key class can be implemented by (1) subclassing the semantic key class; overriding the methods that access the default semantic key (changeStoredKey, storeKey, deleteKey).

Supported API: true

Extendable: true

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
abstract String	getIdentity()	Constructs and returns a string representing the object's identity.
protected String	getKeyClassName()	Creates a name for the uniqueness constraint.
protected SemanticKey	getSemanticKey(UniquelyIdentified obj)	Gets the SemanticKey to store for this identification object and UniquelyIdentified object.
protected void	initialize(Identified obj)	Initializes objects created by new-factory methods.
protected abstract void	setToObject(Identified obj)	Updates the identity of the object passed as argument with the identity held in the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getKeyClassName

protected String getKeyClassName()

Creates a name for the uniqueness constraint. The default implementation uses the name of the class, which makes it inappropriate for uniqueness constraints spanning several classes.

Supported API: true

Returns:

String

getIdentity

public abstract String getIdentity()

Constructs and returns a string representing the object's identity. This is an abstract method that must be implemented by classes extending the IdentifiactionObject class. A straightforward way of build a string representation of the identity is to concatenate the attributes that constitute the identity, using an appropriate separator.

Supported API: true

Returns:

String

initialize

protected void initialize(Identified obj)
                   throws WTException

Initializes objects created by new-factory methods.

Supported API: true

Parameters:

obj -

Throws:

WTException

setToObject

protected abstract void setToObject(Identified obj)
                             throws WTException

Updates the identity of the object passed as argument with the identity held in the object.

Supported API: true

Parameters:

obj -

Throws:

WTException

getSemanticKey

protected SemanticKey getSemanticKey(UniquelyIdentified obj)
                              throws WTException

Gets the SemanticKey to store for this identification object and UniquelyIdentified object.

Supported API: true

Parameters:

obj -

Returns:

SemanticKey

Throws:

WTException