wt.epm.structure
Interface EPMDependencyLink

All Superinterfaces:

EPMObject, IBAHolder, NetFactor, ObjectMappable, Persistable, Serializable, Typed

All Known Implementing Classes:

EPMMemberLink, EPMReferenceLink

public interface EPMDependencyLink

extends EPMObject, Typed

The generic form of dependency between two EPMDocument objects.

Supported API: true

Extendable: false

See Also:

EPMReferenceLink, EPMMemberLink

Field Summary

static String	AS_STORED_CHILD_NAME Label for the attribute; Specifies the name of the "child" document as it was known by the application when it created the dependency link.
static String	DEP_TYPE Label for the attribute; an integer that authoring application may use to designate the type of dependency Supported API: true
static String	HAS_IBAVALUES Label for the attribute; Signifies whether or not this EPM Dependency link has IBA values.
static String	REQUIRED Label for the attribute; Designates that the authoring application requires the "child" document in order to work with the "parent" document.
static String	UNIQUE_LINK_ID Label for the attribute; An internally generated unique link identifier.
static String	UNIQUE_NDID Label for the attribute.

Fields inherited from interface wt.epm.EPMObject

AUTHORING_APPLICATION, OWNER_APPLICATION, UNSPECIFIED

Fields inherited from interface wt.type.Typed

TYPE_DEFINITION_REFERENCE

Fields inherited from interface wt.iba.value.IBAHolder

ATTRIBUTE_CONTAINER

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Method Summary

String	getAsStoredChildName() Gets the value of the attribute: AS_STORED_CHILD_NAME.
int	getDepType() Gets the value of the attribute: DEP_TYPE.
long	getUniqueLinkID() Gets the value of the attribute: UNIQUE_LINK_ID.
String	getUniqueNDId() Gets the value of the attribute: UNIQUE_NDID.
boolean	isHasIBAValues() Gets the value of the attribute: HAS_IBAVALUES.
boolean	isRequired() Gets the value of the attribute: REQUIRED.
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 interface wt.epm.EPMObject

checkAttributes, getAuthoringApplication, getOwnerApplication

Methods inherited from interface wt.type.Typed

getTypeDefinitionReference, setTypeDefinitionReference

Methods inherited from interface wt.iba.value.IBAHolder

getAttributeContainer, setAttributeContainer

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.ObjectMappable

readExternal, writeExternal

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Field Detail

AS_STORED_CHILD_NAME

public static final String AS_STORED_CHILD_NAME

Label for the attribute; 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

See Also:

Constant Field Values

DEP_TYPE

public static final String DEP_TYPE

Label for the attribute; an integer that authoring application may use to designate the type of dependency

Supported API: true

See Also:

Constant Field Values

REQUIRED

public static final String REQUIRED

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

Supported API: true

See Also:

Constant Field Values

UNIQUE_LINK_ID

public static final String UNIQUE_LINK_ID

Label for the attribute; An internally generated unique link identifier. It may be read but not changed.

Supported API: true

See Also:

Constant Field Values

UNIQUE_NDID

public static final String UNIQUE_NDID

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

HAS_IBAVALUES

public static final String HAS_IBAVALUES

Label for the attribute; Signifies whether or not this EPM Dependency link has IBA values.

The reason for this flag is to improve performance by significantly reducing the number of IBA related queries. Querying for IBA values is expensive. In practice, only a very small percentage of EPM Dependency links will ever have IBA values.

Supported API: false

See Also:

Constant Field Values

Method Detail

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

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

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

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

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

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

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

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

Parameters:

a_UniqueLinkID -

Throws:

WTPropertyVetoException

getUniqueNDId

public String getUniqueNDId()

Gets the value of the attribute: UNIQUE_NDID.

Supported API: true

Returns:

String

setUniqueNDId

public void setUniqueNDId(String a_UniqueNDId)
                   throws WTPropertyVetoException

Sets the value of the attribute: UNIQUE_NDID.

Supported API: true

Parameters:

a_UniqueNDId -

Throws:

WTPropertyVetoException

isHasIBAValues

public boolean isHasIBAValues()

Gets the value of the attribute: HAS_IBAVALUES. Signifies whether or not this EPM Dependency link has IBA values.

The reason for this flag is to improve performance by significantly reducing the number of IBA related queries. Querying for IBA values is expensive. In practice, only a very small percentage of EPM Dependency links will ever have IBA values.

Supported API: false

Returns:

boolean