wt.epm.structure
Class EPMReferenceLink

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          wt.epm.structure.EPMReferenceLink

All Implemented Interfaces:

Externalizable, Serializable, EPMObject, EPMDependencyLink, wt.fc.archive.Archiveable, BinaryLink, Link, NetFactor, ObjectMappable, Persistable, wt.iba.value.IBAHolder, DisplayIdentification, wt.type.FlexTyped, wt.type.Typed

public final class EPMReferenceLink
extends ObjectToObjectLink
implements EPMDependencyLink, wt.fc.archive.Archiveable, Externalizable

Associates an EPMDocument with a WTDocument or 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

Fields inherited from interface wt.epm.EPMObject

AUTHORING_APPLICATION, OWNER_APPLICATION

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
String	getAsStoredChildName() Gets the value of the attribute: AS_STORED_CHILD_NAME.
EPMAuthoringAppType	getAuthoringApplication() Gets the value of the attribute: AUTHORING_APPLICATION.
int	getDepType() Gets the value of the attribute: DEP_TYPE.
EPMApplicationType	getOwnerApplication() Gets the value of the attribute: OWNER_APPLICATION.
long	getUniqueLinkID() Gets the value of the attribute: UNIQUE_LINK_ID.
String	getUniqueNDId() Gets the value of the attribute: UNIQUE_NDID.
protected void	initialize(EPMDocument referencedBy, DocumentMaster references, String asStoredChildName, int depType) Deprecated.
protected void	initialize(EPMDocument referencedBy, EPMDocumentMaster references, String asStoredChildName, int depType, EPMReferenceType referenceType) Supports initialization, following construction of an instance.
boolean	isRequired() Gets the value of the attribute: REQUIRED.
static EPMReferenceLink	newEPMReferenceLink(EPMDocument referencedBy, DocumentMaster references) Deprecated.
static EPMReferenceLink	newEPMReferenceLink(EPMDocument referencedBy, DocumentMaster 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.
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.
void	setUniqueLinkID(long a_UniqueLinkID) Sets the value of the attribute: UNIQUE_LINK_ID.
void	setUniqueNDId(String a_UniqueNDId) Sets the value of the attribute: UNIQUE_NDID.

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 Detail

newEPMReferenceLink

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

Deprecated.

Constructs an EPMReferenceLink.

By default, this constructor sets 'asStoredChildName' to null, 'depType' to UNSPECIFIED and 'required' to false. Deprecated in 9.0. Link to DocumentMaster no longer supported.

Supported API: true

Parameters:

referencedBy -

references -

Returns:

EPMReferenceLink

Throws:

WTException

newEPMReferenceLink

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

Deprecated.

Constructs an EPMReferenceLink.

By default, this constructor sets 'required' to false. Deprecated in 9.0. Link to DocumentMaster no longer supported.

Supported API: true

Parameters:

referencedBy -

references -

asStoredChildName -

depType -

Returns:

EPMReferenceLink

Throws:

WTException

initialize

protected void initialize(EPMDocument referencedBy,
                          DocumentMaster 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

getAsStoredChildName

public String getAsStoredChildName()

Gets 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:

getAsStoredChildName in interface EPMDependencyLink

Returns:

String

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

Parameters:

a_AsStoredChildName -

Throws:

WTPropertyVetoException

getDepType

public int getDepType()

Gets 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:

getDepType in interface EPMDependencyLink

Returns:

int

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

Parameters:

a_DepType -

Throws:

WTPropertyVetoException

isRequired

public boolean isRequired()

Gets 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:

isRequired in interface EPMDependencyLink

Returns:

boolean

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

Parameters:

a_Required -

Throws:

WTPropertyVetoException

getUniqueLinkID

public long getUniqueLinkID()

Gets the value of the attribute: UNIQUE_LINK_ID. An internally generated unique link identifier. It may be read but not changed.

Supported API: true

Specified by:

getUniqueLinkID in interface EPMDependencyLink

Returns:

long

setUniqueLinkID

public void setUniqueLinkID(long a_UniqueLinkID)
                     throws WTPropertyVetoException

Sets the value of the attribute: UNIQUE_LINK_ID. An internally generated unique link identifier. It may be read but not changed.

Supported API: true

Specified by:

setUniqueLinkID in interface EPMDependencyLink

Parameters:

a_UniqueLinkID -

Throws:

WTPropertyVetoException

getUniqueNDId

public String getUniqueNDId()

Gets the value of the attribute: UNIQUE_NDID.

Supported API: true

Specified by:

getUniqueNDId in interface EPMDependencyLink

Returns:

String

setUniqueNDId

public void setUniqueNDId(String a_UniqueNDId)
                   throws WTPropertyVetoException

Sets the value of the attribute: UNIQUE_NDID.

Supported API: true

Specified by:

setUniqueNDId in interface EPMDependencyLink

Parameters:

a_UniqueNDId -

Throws:

WTPropertyVetoException

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

Specified by:

getOwnerApplication in interface EPMObject

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

Specified by:

getAuthoringApplication in interface EPMObject

Returns:

EPMAuthoringAppType

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

In particular, this must check that the modifications to the object were made by an approved application.

Supported API: true

Specified by:

checkAttributes in interface EPMObject

Throws:

InvalidAttributeException