wt.part
Class WTPartReferenceLink

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          wt.vc.struct.IteratedReferenceLink
              wt.part.WTPartReferenceLink

All Implemented Interfaces:

Archiveable, BinaryLink, DisplayIdentification, Externalizable, Link, NetFactor, ObjectMappable, Persistable, Releasable, Serializable, WTPartDocumentLink

public class WTPartReferenceLink

extends IteratedReferenceLink

implements Releasable, Archiveable, WTPartDocumentLink, Externalizable

Associates a WTPart with the WTDocuments it calls out. These documents can be standards documents or any other kind of document that evolves independently of the part. Note that this link may not not appropriate if the document can not be interchanged with respect to the part.

Use the newWTPartReferenceLink static factory method(s), not the WTPartReferenceLink 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:

WTPart, WTDocumentMaster, IteratedReferenceLink, Serialized Form

Field Summary

static String	ALL_ROLES
static String	BOTH_ROLES
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
protected static long	OLD_FORMAT_VERSION_UID
static String	REFERENCED_BY_ROLE Label for the attribute.
static String	REFERENCES_ROLE Label for the attribute.
private static String	RESOURCE
static String	ROLE_AOBJECT_REF
static String	ROLE_AOBJECT_ROLE
static String	ROLE_BOBJECT_REF
static String	ROLE_BOBJECT_ROLE
(package private) static long	serialVersionUID

Fields inherited from class wt.fc.ObjectToObjectLink

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

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

WTPartReferenceLink()

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.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
static WTPartReferenceLink	newWTPartReferenceLink(WTPart referencedBy, WTDocumentMaster references) Default factory for the class.
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(WTPartReferenceLink thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setReferencedBy(Iterated referencedBy) Sets the object for the association that plays role: REFERENCED_BY_ROLE.
void	setReferences(Mastered references) Sets the object for the association that plays role: REFERENCES_ROLE.
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.vc.struct.IteratedReferenceLink

getReferencedBy, getReferences, readVersion

Methods inherited from class wt.fc.ObjectToObjectLink

appendJoinCriteria, appendRoleCriteria, duplicate, getAllObjects, getJoinValues, getLinkInfo, getObject, getOtherObject, getRemoteRoleAObjectId, getRemoteRoleBObjectId, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, getRoleIdName, getRoleObject, initialize, isRoleANonpersistentProxy, isRoleBNonpersistentProxy, readVersion, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef, setRoleObject

Methods inherited from class wt.fc.WTObject

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Methods inherited from interface wt.fc.BinaryLink

getLinkInfo, getObject, getOtherObject, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef

Methods inherited from interface wt.fc.Link

appendJoinCriteria, appendRoleCriteria, getAllObjects, getJoinValues, getRoleIdName, getRoleObject, setRoleObject

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

REFERENCED_BY_ROLE

public static final String REFERENCED_BY_ROLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

REFERENCES_ROLE

public static final String REFERENCES_ROLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

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

ROLE_AOBJECT_ROLE

public static final String ROLE_AOBJECT_ROLE

See Also:

Constant Field Values

ROLE_BOBJECT_ROLE

public static final String ROLE_BOBJECT_ROLE

See Also:

Constant Field Values

ALL_ROLES

public static final String ALL_ROLES

See Also:

Constant Field Values

BOTH_ROLES

public static final String BOTH_ROLES

See Also:

Constant Field Values

ROLE_AOBJECT_REF

public static final String ROLE_AOBJECT_REF

See Also:

Constant Field Values

ROLE_BOBJECT_REF

public static final String ROLE_BOBJECT_REF

See Also:

Constant Field Values

Constructor Detail

WTPartReferenceLink

public WTPartReferenceLink()

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 IteratedReferenceLink

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 IteratedReferenceLink

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WTPartReferenceLink 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 IteratedReferenceLink

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 IteratedReferenceLink

Parameters:

input -

Throws:

SQLException

DatastoreException

setReferencedBy

public void setReferencedBy(Iterated referencedBy)
                     throws WTPropertyVetoException

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

Supported API: true

Overrides:

setReferencedBy in class IteratedReferenceLink

Parameters:

referencedBy -

Throws:

WTPropertyVetoException

setReferences

public void setReferences(Mastered references)
                   throws WTPropertyVetoException

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

Supported API: true

Overrides:

setReferences in class IteratedReferenceLink

Parameters:

references -

Throws:

WTPropertyVetoException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

newWTPartReferenceLink

public static WTPartReferenceLink newWTPartReferenceLink(WTPart referencedBy,
                                                         WTDocumentMaster references)
                                                  throws WTException

Default factory for the class.

Supported API: false

Parameters:

referencedBy -

references -

Returns:

WTPartReferenceLink

Throws:

WTException

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 IteratedReferenceLink

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 IteratedReferenceLink

Returns:

int