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

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

@GenAsBinaryLink(superClass=ObjectToObjectLink.class,
                 interfaces={EPMDependencyLink.class,wt.fc.archive.Archiveable.class,Releasable.class},
                 versions=1033375453219788529L,
                 properties=@GeneratedProperty(name="referenceType",type=EPMReferenceType.class,javaDoc="Type of reference relationship that is CAD application neutral.",constraints=@PropertyConstraints(required=true)),
                 roleA=@GeneratedRole(name="referencedBy",type=EPMDocument.class,cardinality=ONE_TO_MANY),
                 roleB=@GeneratedRole(name="references",type=EPMDependencyMaster.class,accessors=@PropertyAccessors(setAccess=PRIVATE),cardinality=ONE_TO_MANY,owner=false),
                 tableProperties=@TableProperties(compositeIndex1="+roleBObjectRef.key.id",compositeIndex2="+roleAObjectRef.key.id",compositeIndex5="roleBObjectRef.key.id+referenceType+roleAObjectRef.key.id",compositeIndex6="referenceType+[Include]roleAObjectRef.key.id+roleBObjectRef.key.id",tableName="EPMReferenceLink"))
public final class EPMReferenceLink
extends _EPMReferenceLink

Associates an EPMDocument with another EPMDocument.

An IteratedReferenceLink associates an Iterated object with a Mastered object. Logically, an EPMReferenceLink associates an EPMDocument with a EPMDocumentMaster. Since the DocumentMaster interface does not extend Mastered, an EPMReferenceLink must associate an EPMDocument with a Master.

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

Fields inherited from interface wt.epm.structure._EPMDependencyLink

AS_STORED_CHILD_NAME, DEP_TYPE, REQUIRED, UNIQUE_LINK_ID, UNIQUE_NDID

Method Summary

Modifier and Type	Method	Description
EPMAuthoringAppType	getAuthoringApplication()	Gets the value of the attribute: AUTHORING_APPLICATION.
EPMApplicationType	getOwnerApplication()	Gets the value of the attribute: OWNER_APPLICATION.
protected void	initialize(EPMDocument referencedBy, EPMDocumentMaster references, String asStoredChildName, int depType, EPMReferenceType referenceType)	Supports initialization, following construction of an instance.
protected void	initialize(EPMDocument referencedBy, EPMDependencyMaster references, String asStoredChildName, int depType)	Deprecated.
static EPMReferenceLink	newEPMReferenceLink(EPMDocument referencedBy, EPMDocumentMaster references)	Constructs an EPMReferenceLink.
static EPMReferenceLink	newEPMReferenceLink(EPMDocument referencedBy, EPMDocumentMaster references, String asStoredChildName, int depType, EPMReferenceType referenceType)	Constructs an EPMReferenceLink.
static EPMReferenceLink	newEPMReferenceLink(EPMDocument referencedBy, EPMDependencyMaster references)	Deprecated.
static EPMReferenceLink	newEPMReferenceLink(EPMDocument referencedBy, EPMDependencyMaster references, String asStoredChildName, int depType)	Deprecated.
void	setAsStoredChildName(String a_AsStoredChildName)	Sets the value of the attribute: AS_STORED_CHILD_NAME.
void	setDepType(int a_DepType)	Sets the value of the attribute: DEP_TYPE.
void	setRequired(boolean a_Required)	Sets the value of the attribute: REQUIRED.

Methods inherited from class wt.epm.structure._EPMReferenceLink

getAsStoredChildName, getDepType, getUniqueLinkID, getUniqueNDId, isRequired, setUniqueLinkID, setUniqueNDId

Methods inherited from class wt.fc.ObjectToObjectLink

appendJoinCriteria, duplicate, getAllObjects, getJoinValues, getRoleObject, setRoleObject

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

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

Method Details

newEPMReferenceLink

public static EPMReferenceLink newEPMReferenceLink(EPMDocument referencedBy,
 EPMDependencyMaster references)
                                            throws WTException

Deprecated.

Constructs an EPMReferenceLink.

By default, this constructor sets 'asStoredChildName' to null, 'depType' to UNSPECIFIED and 'required' to false.

Supported API: true

Parameters:

referencedBy -

references -

Returns:

EPMReferenceLink

Throws:

WTException

newEPMReferenceLink

public static EPMReferenceLink newEPMReferenceLink(EPMDocument referencedBy,
 EPMDependencyMaster references,
 String asStoredChildName,
 int depType)
                                            throws WTException

Deprecated.

Constructs an EPMReferenceLink.

By default, this constructor sets 'required' to false.

Supported API: true

Parameters:

referencedBy -

references -

asStoredChildName -

depType -

Returns:

EPMReferenceLink

Throws:

WTException

initialize

protected void initialize(EPMDocument referencedBy,
 EPMDependencyMaster references,
 String asStoredChildName,
 int depType)
                   throws WTException

Deprecated.

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

referencedBy -

references -

asStoredChildName -

depType -

Throws:

WTException

newEPMReferenceLink

public static EPMReferenceLink newEPMReferenceLink(EPMDocument referencedBy,
 EPMDocumentMaster references)
                                            throws WTException

Constructs an EPMReferenceLink.

By default, this constructor sets 'required' to false.

Supported API: true

Parameters:

referencedBy -

references -

Returns:

EPMReferenceLink

Throws:

WTException

newEPMReferenceLink

public static EPMReferenceLink newEPMReferenceLink(EPMDocument referencedBy,
 EPMDocumentMaster references,
 String asStoredChildName,
 int depType,
 EPMReferenceType referenceType)
                                            throws WTException

Constructs an EPMReferenceLink.

By default, this constructor sets 'required' to false.

Supported API: true

Parameters:

referencedBy -

references -

asStoredChildName -

depType -

referenceType -

Returns:

EPMReferenceLink

Throws:

WTException

initialize

protected void initialize(EPMDocument referencedBy,
 EPMDocumentMaster references,
 String asStoredChildName,
 int depType,
 EPMReferenceType referenceType)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

referencedBy -

references -

asStoredChildName -

depType -

referenceType -

Throws:

WTException

setAsStoredChildName

public void setAsStoredChildName(String a_AsStoredChildName)
                          throws WTPropertyVetoException

Sets the value of the attribute: AS_STORED_CHILD_NAME. 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

Overrides:

setAsStoredChildName in class _EPMReferenceLink

Parameters:

a_AsStoredChildName -

Throws:

WTPropertyVetoException

See Also:

• EPMDependencyLink

setDepType

public void setDepType(int a_DepType)
                throws WTPropertyVetoException

Sets the value of the attribute: DEP_TYPE. an integer that authoring application may use to designate the type of dependency

Supported API: true

Specified by:

setDepType in interface _EPMDependencyLink

Overrides:

setDepType in class _EPMReferenceLink

Parameters:

a_DepType -

Throws:

WTPropertyVetoException

See Also:

• EPMDependencyLink

setRequired

public void setRequired(boolean a_Required)
                 throws WTPropertyVetoException

Sets the value of the attribute: REQUIRED. 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

Overrides:

setRequired in class _EPMReferenceLink

Parameters:

a_Required -

Throws:

WTPropertyVetoException

See Also:

• EPMDependencyLink

getOwnerApplication

public EPMApplicationType getOwnerApplication()

Gets the value of the attribute: OWNER_APPLICATION. Indicate that the named application owns the object.

The parameter is an EPMApplicationType, so that any sort of checking can be done at run-time.

Supported API: true

Returns:

EPMApplicationType

getAuthoringApplication

public EPMAuthoringAppType getAuthoringApplication()

Gets the value of the attribute: AUTHORING_APPLICATION. Indicates that the named application authored the object.

The parameter is an EPMAuthoringAppType, so that any sort of checking can be done at run-time.

Supported API: true

Returns:

EPMAuthoringAppType