wt.doc
Class WTDocumentDependencyLink

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          wt.vc.struct.IteratedDescribeLink
              wt.doc.WTDocumentDependencyLink

All Implemented Interfaces:

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

public class WTDocumentDependencyLink

extends IteratedDescribeLink

implements Externalizable

The link is a ObjectToObjectLink between two WTDocuments. The link is used to show dependencies between documents. It is an iteration to iteration link that must be copied forward to the next iteration on a revise or checkout. The comment field is for users to record the reason for the dependency. It is recommended that customers use the createDependencyLink methods in WTDocumentService, which are called using the following format call WTDocumentHelper.service.createDependencyLink instead of directly calling the static factory method newWTDocumentDependencyLink that is mentioned in the next paragraph. The methods in WTDocumentService offer more functionality and correctly use newWTDocumentDependencyLink to initialize the object.

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

WTDocument, ObjectToObjectLink, Serialized Form

Field Summary

private static String	CLASSNAME
static String	DEPENDS_ON Label for the attribute; Role B.
static String	DEPENDS_ON_ROLE
static String	DESCRIBED_BY_ROLE Label for the attribute.
static String	DESCRIBES_ROLE Label for the attribute.
static long	EXTERNALIZATION_VERSION_UID
static String	HAS_DEPENDENT Label for the attribute; Role A.
static String	HAS_DEPENDENT_ROLE
static String	LINK_DESCRIPTION Label for the attribute; Used to record the reason that this dependency link was created.
private static int	LINK_DESCRIPTION_UPPER_LIMIT
private String	linkDescription
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID

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

WTDocumentDependencyLink()

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.
WTDocument	getDependsOn() Gets the value of the attribute: DEPENDS_ON.
WTDocument	getHasDependent() Gets the value of the attribute: HAS_DEPENDENT.
String	getLinkDescription() Gets the value of the attribute: LINK_DESCRIPTION.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	linkDescriptionValidate(String a_LinkDescription)
static WTDocumentDependencyLink	newWTDocumentDependencyLink(WTDocument describes, WTDocument describedBy) Default factory for the class.
static WTDocumentDependencyLink	newWTDocumentDependencyLink(WTDocument hasDependent, WTDocument dependsOn, String comment) Special factory for setting the comment on creation of the link.
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(WTDocumentDependencyLink thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setDependsOn(WTDocument a_DependsOn) Sets the value of the attribute: DEPENDS_ON.
void	setDescribedBy(Iterated describedBy) Sets the object for the association that plays role: DESCRIBED_BY_ROLE.
void	setDescribes(Iterated describes) Sets the object for the association that plays role: DESCRIBES_ROLE.
void	setHasDependent(WTDocument a_HasDependent) Sets the value of the attribute: HAS_DEPENDENT.
void	setLinkDescription(String a_LinkDescription) Sets the value of the attribute: LINK_DESCRIPTION.
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.IteratedDescribeLink

getDescribedBy, getDescribes, 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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

DESCRIBES_ROLE

public static final String DESCRIBES_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

DESCRIBED_BY_ROLE

public static final String DESCRIBED_BY_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

LINK_DESCRIPTION

public static final String LINK_DESCRIPTION

Label for the attribute; Used to record the reason that this dependency link was created.

Supported API: false

See Also:

Constant Field Values

LINK_DESCRIPTION_UPPER_LIMIT

private static int LINK_DESCRIPTION_UPPER_LIMIT

linkDescription

private String linkDescription

DEPENDS_ON

public static final String DEPENDS_ON

Label for the attribute; Role B.

Supported API: false

See Also:

Constant Field Values

HAS_DEPENDENT

public static final String HAS_DEPENDENT

Label for the attribute; Role A.

Supported API: false

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

HAS_DEPENDENT_ROLE

public static final String HAS_DEPENDENT_ROLE

See Also:

Constant Field Values

DEPENDS_ON_ROLE

public static final String DEPENDS_ON_ROLE

See Also:

Constant Field Values

Constructor Detail

WTDocumentDependencyLink

public WTDocumentDependencyLink()

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 IteratedDescribeLink

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 IteratedDescribeLink

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(WTDocumentDependencyLink 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 IteratedDescribeLink

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 IteratedDescribeLink

Parameters:

input -

Throws:

SQLException

DatastoreException

setDescribes

public void setDescribes(Iterated describes)
                  throws WTPropertyVetoException

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

Supported API: false

Overrides:

setDescribes in class IteratedDescribeLink

Parameters:

describes -

Throws:

WTPropertyVetoException

setDescribedBy

public void setDescribedBy(Iterated describedBy)
                    throws WTPropertyVetoException

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

Supported API: false

Overrides:

setDescribedBy in class IteratedDescribeLink

Parameters:

describedBy -

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

getLinkDescription

public String getLinkDescription()

Gets the value of the attribute: LINK_DESCRIPTION. Used to record the reason that this dependency link was created.

Supported API: false

Returns:

String

setLinkDescription

public void setLinkDescription(String a_LinkDescription)
                        throws WTPropertyVetoException

Sets the value of the attribute: LINK_DESCRIPTION. Used to record the reason that this dependency link was created.

Supported API: false

Parameters:

a_LinkDescription -

Throws:

WTPropertyVetoException

linkDescriptionValidate

private void linkDescriptionValidate(String a_LinkDescription)
                              throws WTPropertyVetoException

Parameters:

a_LinkDescription -

Throws:

WTPropertyVetoException

getDependsOn

public WTDocument getDependsOn()

Gets the value of the attribute: DEPENDS_ON. Role B.

Supported API: false

Returns:

WTDocument

setDependsOn

public void setDependsOn(WTDocument a_DependsOn)
                  throws WTPropertyVetoException

Sets the value of the attribute: DEPENDS_ON. Role B.

Supported API: false

Parameters:

a_DependsOn -

Throws:

WTPropertyVetoException

getHasDependent

public WTDocument getHasDependent()

Gets the value of the attribute: HAS_DEPENDENT. Role A.

Supported API: false

Returns:

WTDocument

setHasDependent

public void setHasDependent(WTDocument a_HasDependent)
                     throws WTPropertyVetoException

Sets the value of the attribute: HAS_DEPENDENT. Role A.

Supported API: false

Parameters:

a_HasDependent -

Throws:

WTPropertyVetoException

newWTDocumentDependencyLink

public static WTDocumentDependencyLink newWTDocumentDependencyLink(WTDocument hasDependent,
                                                                   WTDocument dependsOn,
                                                                   String comment)
                                                            throws WTException

Special factory for setting the comment on creation of the link.

Supported API: false

Parameters:

hasDependent - Doc A dependsOn B, A is the hasDependent object (describes).

dependsOn - Doc A dependsOn B, B is the dependsOn object (describedBy).

comment - Reason for dependency being created.

Returns:

WTDocumentDependencyLink

Throws:

WTException

newWTDocumentDependencyLink

public static WTDocumentDependencyLink newWTDocumentDependencyLink(WTDocument describes,
                                                                   WTDocument describedBy)
                                                            throws WTException

Default factory for the class.

Supported API: false

Parameters:

describes -

describedBy -

Returns:

WTDocumentDependencyLink

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 IteratedDescribeLink

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 IteratedDescribeLink

Returns:

int