Package wt.epm.structure

Class _EPMReferenceLink

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.fc._ObjectToObjectLink

wt.fc.ObjectToObjectLink

wt.epm.structure._EPMReferenceLink

All Implemented Interfaces:

Externalizable, Serializable, wt.epm._EPMObject, EPMObject, _EPMDependencyLink, EPMDependencyLink, wt.esi._Releasable, Releasable, wt.fc._BinaryLink, wt.fc._Link, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.archive._Archiveable, wt.fc.archive.Archiveable, BinaryLink, Link, NetFactor, ObjectMappable, Persistable, wt.iba.value._IBAHolder, wt.iba.value.IBAHolder, DisplayIdentification, wt.type._Typed, wt.type._TypeManaged, wt.type.FlexTyped, wt.type.Typed, wt.type.TypeManaged

Direct Known Subclasses:

EPMReferenceLink

public abstract class _EPMReferenceLink
extends ObjectToObjectLink
implements EPMDependencyLink, wt.fc.archive.Archiveable, Releasable, Externalizable

See Also:

• Serialized Form

Field Summary

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

ROLE_AOBJECT_ROLE, ROLE_BOBJECT_ROLE

Fields inherited from interface wt.epm.structure._EPMDependencyLink

AS_STORED_CHILD_NAME, DEP_TYPE, HAS_IBAVALUES, REQUIRED, UNIQUE_LINK_ID, UNIQUE_NDID

Fields inherited from interface wt.iba.value._IBAHolder

ATTRIBUTE_CONTAINER

Fields inherited from interface wt.fc._Persistable

PERSIST_INFO

Fields inherited from interface wt.type._Typed

TYPE_DEFINITION_REFERENCE

Fields inherited from interface wt.fc.BinaryLink

ALL_ROLES, BOTH_ROLES

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Fields inherited from interface wt.epm.EPMObject

AUTHORING_APPLICATION, OWNER_APPLICATION, UNSPECIFIED

Fields inherited from interface wt.fc.Persistable

IDENTITY, TYPE

Method Summary

Modifier and Type	Method	Description
String	getAsStoredChildName()	Specifies the name of the "child" document as it was known by the application when it created the dependency link.
int	getDepType()	an integer that authoring application may use to designate the type of dependency
long	getUniqueLinkID()	uniqueLinkId is used to identify the identical member links between parent and child document.
String	getUniqueNDId()	uniqueNDId is used to identify the identical member links between parent and child document in Neutral Data.
boolean	isRequired()	Designates that the authoring application requires the "child" document in order to work with the "parent" document.
void	setAsStoredChildName(String asStoredChildName)	Specifies the name of the "child" document as it was known by the application when it created the dependency link.
void	setDepType(int depType)	an integer that authoring application may use to designate the type of dependency
void	setRequired(boolean required)	Designates that the authoring application requires the "child" document in order to work with the "parent" document.
void	setUniqueLinkID(long uniqueLinkID)	uniqueLinkId is used to identify the identical member links between parent and child document.
void	setUniqueNDId(String uniqueNDId)	uniqueNDId is used to identify the identical member links between parent and child document in Neutral Data.

Methods inherited from class wt.fc.ObjectToObjectLink

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

Methods inherited from class wt.fc._ObjectToObjectLink

getRoleAObjectRef, getRoleBObjectRef, readVersion, super_readExternal_ObjectToObjectLink, super_readVersion_ObjectToObjectLink, super_writeExternal_ObjectToObjectLink

Methods inherited from class wt.fc.WTObject

checkAttributes, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, initialize, toString

Methods inherited from class wt.fc._WTObject

equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc._Persistable

getPersistInfo, setPersistInfo

Methods inherited from interface wt.epm.EPMObject

checkAttributes, getAuthoringApplication, getOwnerApplication

Methods inherited from interface wt.type.FlexTyped

getFlexTypeIdPath, getTypeDefinitionInfo, getValue, setValue

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity

Method Details

getAsStoredChildName

public String getAsStoredChildName()

Specifies the name of the "child" document as it was known by the application when it created the dependency link. Applications often internally save the names of documents that they reference. This field enables those applications to find the correct document after it is renamed.

Supported API: true

Specified by:

getAsStoredChildName in interface _EPMDependencyLink

See Also:

• EPMDependencyLink

setAsStoredChildName

public void setAsStoredChildName(String asStoredChildName)
                          throws WTPropertyVetoException

Specifies the name of the "child" document as it was known by the application when it created the dependency link. Applications often internally save the names of documents that they reference. This field enables those applications to find the correct document after it is renamed.

Supported API: true

Specified by:

setAsStoredChildName in interface _EPMDependencyLink

Throws:

WTPropertyVetoException

See Also:

• EPMDependencyLink

getDepType

public int getDepType()

an integer that authoring application may use to designate the type of dependency

Supported API: true

Specified by:

getDepType in interface _EPMDependencyLink

See Also:

• EPMDependencyLink

setDepType

public void setDepType(int depType)
                throws WTPropertyVetoException

an integer that authoring application may use to designate the type of dependency

Supported API: true

Specified by:

setDepType in interface _EPMDependencyLink

Throws:

WTPropertyVetoException

See Also:

• EPMDependencyLink

isRequired

public boolean isRequired()

Designates that the authoring application requires the "child" document in order to work with the "parent" document.

Supported API: true

Specified by:

isRequired in interface _EPMDependencyLink

See Also:

• EPMDependencyLink

setRequired

public void setRequired(boolean required)
                 throws WTPropertyVetoException

Designates that the authoring application requires the "child" document in order to work with the "parent" document.

Supported API: true

Specified by:

setRequired in interface _EPMDependencyLink

Throws:

WTPropertyVetoException

See Also:

• EPMDependencyLink

getUniqueLinkID

public long getUniqueLinkID()

uniqueLinkId is used to identify the identical member links between parent and child document. Its uniqueness scope is within the system. It is an internally generated unique link identifier. It may be read but not changed.

Supported API: true

Specified by:

getUniqueLinkID in interface _EPMDependencyLink

See Also:

• EPMDependencyLink

setUniqueLinkID

public void setUniqueLinkID(long uniqueLinkID)
                     throws WTPropertyVetoException

uniqueLinkId is used to identify the identical member links between parent and child document. Its uniqueness scope is within the system. It is an internally generated unique link identifier. It may be read but not changed.

Supported API: true

Specified by:

setUniqueLinkID in interface _EPMDependencyLink

Throws:

WTPropertyVetoException

See Also:

• EPMDependencyLink

getUniqueNDId

public String getUniqueNDId()

uniqueNDId is used to identify the identical member links between parent and child document in Neutral Data. Its uniqueness scope is within the system. It is an internally generated unique link identifier. It may be read but not changed.

Supported API: true

Specified by:

getUniqueNDId in interface _EPMDependencyLink

See Also:

• EPMDependencyLink

setUniqueNDId

public void setUniqueNDId(String uniqueNDId)
                   throws WTPropertyVetoException

uniqueNDId is used to identify the identical member links between parent and child document in Neutral Data. Its uniqueness scope is within the system. It is an internally generated unique link identifier. It may be read but not changed.

Supported API: true

Specified by:

setUniqueNDId in interface _EPMDependencyLink

Throws:

WTPropertyVetoException

See Also:

• EPMDependencyLink