wt.part
Class WTPartSubstituteLink

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          wt.part.WTPartSubstituteLink

All Implemented Interfaces:

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

public class WTPartSubstituteLink

extends ObjectToObjectLink

implements DomainAdministered, AccessControlled, Externalizable

An association indicating that in the context of a particular usage, another part may be substituted.

Use the newWTPartSubstituteLink static factory method(s), not the WTPartSubstituteLink 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

private static String	CLASSNAME
private AdminDomainRef	domainRef
static long	EXTERNALIZATION_VERSION_UID
private boolean	inheritedDomain
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static String	SUBSTITUTE_FOR_ROLE Label for the attribute.
static String	SUBSTITUTES_ROLE Label for the attribute.

Fields inherited from class wt.fc.ObjectToObjectLink

ROLE_AOBJECT_REF, ROLE_BOBJECT_REF

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.BinaryLink

ALL_ROLES, BOTH_ROLES, ROLE_AOBJECT_ROLE, ROLE_BOBJECT_ROLE

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

WTPartSubstituteLink()

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.
AdminDomainRef	getDomainRef() Gets the object for the association that plays role: DOMAIN_REF.
WTPartUsageLink	getSubstituteFor() Gets the object for the association that plays role: SUBSTITUTE_FOR_ROLE.
WTPartMaster	getSubstitutes() Gets the object for the association that plays role: SUBSTITUTES_ROLE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(WTPartUsageLink substituteFor, WTPartMaster substitute) Initializes new link Supported API: false
boolean	isInheritedDomain() Gets the value of the attribute: INHERITED_DOMAIN.
static WTPartSubstituteLink	newWTPartSubstituteLink() Creates a new WTPartSubstituteLink.
static WTPartSubstituteLink	newWTPartSubstituteLink(WTPartUsageLink substituteFor, WTPartMaster substitutes) Creates a new WTPartSubstituteLink.
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(WTPartSubstituteLink thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDomainRef(AdminDomainRef a_DomainRef) Sets the object for the association that plays role: DOMAIN_REF.
void	setInheritedDomain(boolean a_InheritedDomain) Sets the value of the attribute: INHERITED_DOMAIN.
void	setRoleAObjectRef(WTReference a_RoleAObjectRef) Sets the object for the association that plays role: ROLE_AOBJECT_REF.
void	setSubstituteFor(WTPartUsageLink substituteFor) Sets the object for the association that plays role: SUBSTITUTE_FOR_ROLE.
void	setSubstitutes(WTPartMaster substitutes) Sets the object for the association that plays role: SUBSTITUTES_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.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, 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.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

SUBSTITUTE_FOR_ROLE

public static final String SUBSTITUTE_FOR_ROLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

SUBSTITUTES_ROLE

public static final String SUBSTITUTES_ROLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

inheritedDomain

private boolean inheritedDomain

domainRef

private AdminDomainRef domainRef

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

Constructor Detail

WTPartSubstituteLink

public WTPartSubstituteLink()

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 ObjectToObjectLink

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 ObjectToObjectLink

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WTPartSubstituteLink 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 ObjectToObjectLink

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 ObjectToObjectLink

Parameters:

input -

Throws:

SQLException

DatastoreException

getSubstituteFor

public WTPartUsageLink getSubstituteFor()

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

Supported API: true

Returns:

WTPartUsageLink

setSubstituteFor

public void setSubstituteFor(WTPartUsageLink substituteFor)
                      throws WTPropertyVetoException

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

Supported API: true

Parameters:

substituteFor -

Throws:

WTPropertyVetoException

getSubstitutes

public WTPartMaster getSubstitutes()

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

Supported API: true

Returns:

WTPartMaster

setSubstitutes

public void setSubstitutes(WTPartMaster substitutes)
                    throws WTPropertyVetoException

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

Supported API: true

Parameters:

substitutes -

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

initialize

protected void initialize(WTPartUsageLink substituteFor,
                          WTPartMaster substitute)
                   throws WTException

Initializes new link

Supported API: false

Parameters:

substituteFor -

substitute -

Throws:

WTException

newWTPartSubstituteLink

public static WTPartSubstituteLink newWTPartSubstituteLink(WTPartUsageLink substituteFor,
                                                           WTPartMaster substitutes)
                                                    throws WTException

Creates a new WTPartSubstituteLink.

Supported API: false

Parameters:

substituteFor -

substitutes -

Returns:

WTPartSubstituteLink

Throws:

WTException

newWTPartSubstituteLink

public static WTPartSubstituteLink newWTPartSubstituteLink()
                                                    throws WTException

Creates a new WTPartSubstituteLink.

Supported API: false

Returns:

WTPartSubstituteLink

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 -

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 ObjectToObjectLink

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 ObjectToObjectLink

Returns:

int

setRoleAObjectRef

public void setRoleAObjectRef(WTReference a_RoleAObjectRef)

Sets the object for the association that plays role: ROLE_AOBJECT_REF. Overriden to support core.command.common.bean.entity.CreatePersistentEntityCommand which uses setRoleAObjectRef to generically set the attributes of a BinaryLink

Supported API: false

Specified by:

setRoleAObjectRef in interface BinaryLink

Overrides:

setRoleAObjectRef in class ObjectToObjectLink

Parameters:

a_RoleAObjectRef -