Package wt.epm.structure

Class _EPMMemberLink

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.fc._ObjectToObjectLink

wt.fc.ObjectToObjectLink

wt.vc.struct._IteratedUsageLink

wt.vc.struct.IteratedUsageLink

wt.epm.structure._EPMMemberLink

All Implemented Interfaces:

Externalizable, Serializable, wt.epm._EPMObject, wt.epm.annotation._EPMStructureAnnotatable, EPMStructureAnnotatable, EPMObject, _EPMDependencyLink, wt.epm.structure._EPMIDSpaceContainer, EPMDependencyLink, wt.epm.structure.EPMIDSpaceContainer, 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.federation._FederatedLinkHolder, wt.federation._RemotelyLinkable, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, _Filterable, Filterable, wt.generic._GenericizableLink, wt.generic.GenericizableLink, wt.iba.value._IBAHolder, wt.iba.value.IBAHolder, DisplayIdentification, wt.option._ChoiceMappable, wt.option._Expressionable, wt.option._ExpressionAssignable, ChoiceMappable, Expressionable, ExpressionAssignable, wt.type._Typed, wt.type._TypeManaged, wt.type.FlexTyped, wt.type.Typed, wt.type.TypeManaged, wt.ufid._Federatable, wt.ufid.Federatable

Direct Known Subclasses:

EPMMemberLink

public abstract class _EPMMemberLink
extends IteratedUsageLink
implements EPMDependencyLink, wt.fc.archive.Archiveable, EPMStructureAnnotatable, wt.generic.GenericizableLink, wt.epm.structure.EPMIDSpaceContainer, Releasable, Externalizable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANNOTATED	Indicates whether the member link is annotated.
static final String	FIXED	Indicates a fixed component
static final String	IDENTIFIER	an integer identifier that an application may assign to an EPMMemberLink.
static final String	IDENTIFIER_SPACE_NAME	Supported API: true
static final String	NAME	a name that an application may give to an EPMMemberLink.
static final String	QUANTITY	Supported API: true
static final String	SUPPRESSED	Supported API: true
static final String	TRANSFORM	Supported API: true

Fields inherited from class wt.vc.struct._IteratedUsageLink

USED_BY_ROLE, USES_ROLE

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

FILTERED_STATUS

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
FilteredStatus	getFilteredStatus()	Filtered status as calculated by the filter delegates.
Integer	getIdentifier()	an integer identifier that an application may assign to an EPMMemberLink.
String	getIdentifierSpaceName()	Supported API: true
String	getName()	a name that an application may give to an EPMMemberLink.
Quantity	getQuantity()	Supported API: true
Transform	getTransform()	Supported API: true
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.
EPMDocument	getUsedBy()	Supported API: true
EPMDependencyMaster	getUses()	Supported API: true
boolean	isAnnotated()	Indicates whether the member link is annotated.
boolean	isFixed()	Indicates a fixed component
boolean	isRequired()	Designates that the authoring application requires the "child" document in order to work with the "parent" document.
boolean	isSuppressed()	Supported API: true
void	setAnnotated(boolean annotated)	Indicates whether the member link is annotated.
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	setFilteredStatus(FilteredStatus filteredStatus)	Filtered status as calculated by the filter delegates.
void	setFixed(boolean fixed)	Indicates a fixed component
void	setIdentifier(Integer identifier)	an integer identifier that an application may assign to an EPMMemberLink.
void	setIdentifierSpaceName(String identifierSpaceName)	Supported API: true
void	setName(String name)	a name that an application may give to an EPMMemberLink.
void	setQuantity(Quantity quantity)	Supported API: true
void	setRequired(boolean required)	Designates that the authoring application requires the "child" document in order to work with the "parent" document.
void	setSuppressed(boolean suppressed)	Supported API: true
void	setTransform(Transform transform)	Supported API: true
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.
void	setUsedBy(EPMDocument the_usedBy)	Supported API: true
void	setUses(EPMDependencyMaster the_uses)	Supported API: true

Methods inherited from class wt.vc.struct._IteratedUsageLink

setUsedBy, setUses

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

Methods inherited from interface wt.fc.BinaryLink

getLinkInfo, getOtherObject, getRole, getRoleAObject, getRoleAObjectId, getRoleBObject, getRoleBObjectId, setRoleAObject, setRoleBObject

Methods inherited from interface wt.epm.EPMObject

checkAttributes, getAuthoringApplication, getOwnerApplication

Methods inherited from interface wt.fc.Link

appendJoinCriteria, appendRoleCriteria, getAllObjects, getJoinValues, getRoleIdName, getRoleObject, setRoleObject

Methods inherited from interface wt.fc.Persistable

checkAttributes

Field Details

SUPPRESSED

public static final String SUPPRESSED

Supported API: true

See Also:

• EPMMemberLink
• Constant Field Values

NAME

public static final String NAME

a name that an application may give to an EPMMemberLink.

Supported API: true

See Also:

• EPMMemberLink
• Constant Field Values

IDENTIFIER

public static final String IDENTIFIER

an integer identifier that an application may assign to an EPMMemberLink.

Supported API: true

See Also:

• EPMMemberLink
• Constant Field Values

IDENTIFIER_SPACE_NAME

public static final String IDENTIFIER_SPACE_NAME

Supported API: true

See Also:

• EPMMemberLink
• Constant Field Values

FIXED

public static final String FIXED

Indicates a fixed component

Supported API: true

See Also:

• EPMMemberLink
• Constant Field Values

ANNOTATED

public static final String ANNOTATED

Indicates whether the member link is annotated.

Supported API: true

See Also:

• EPMMemberLink
• Constant Field Values

TRANSFORM

public static final String TRANSFORM

Supported API: true

See Also:

• EPMMemberLink
• Constant Field Values

QUANTITY

public static final String QUANTITY

Supported API: true

See Also:

• EPMMemberLink
• Constant Field Values

Method Details

isSuppressed

public boolean isSuppressed()

Supported API: true

See Also:

• EPMMemberLink

setSuppressed

public void setSuppressed(boolean suppressed)
                   throws WTPropertyVetoException

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMMemberLink

getName

public String getName()

a name that an application may give to an EPMMemberLink.

Supported API: true

See Also:

• EPMMemberLink

setName

public void setName(String name)
             throws WTPropertyVetoException

a name that an application may give to an EPMMemberLink.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMMemberLink

getIdentifier

public Integer getIdentifier()

an integer identifier that an application may assign to an EPMMemberLink.

Supported API: true

See Also:

• EPMMemberLink

setIdentifier

public void setIdentifier(Integer identifier)
                   throws WTPropertyVetoException

an integer identifier that an application may assign to an EPMMemberLink.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMMemberLink

getIdentifierSpaceName

public String getIdentifierSpaceName()

Supported API: true

See Also:

• EPMMemberLink

setIdentifierSpaceName

public void setIdentifierSpaceName(String identifierSpaceName)
                            throws WTPropertyVetoException

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMMemberLink

isFixed

public boolean isFixed()

Indicates a fixed component

Supported API: true

See Also:

• EPMMemberLink

setFixed

public void setFixed(boolean fixed)
              throws WTPropertyVetoException

Indicates a fixed component

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMMemberLink

isAnnotated

public boolean isAnnotated()

Indicates whether the member link is annotated.

Supported API: true

See Also:

• EPMMemberLink

setAnnotated

public void setAnnotated(boolean annotated)
                  throws WTPropertyVetoException

Indicates whether the member link is annotated.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMMemberLink

getTransform

public Transform getTransform()

Supported API: true

See Also:

• EPMMemberLink

setTransform

public void setTransform(Transform transform)
                  throws WTPropertyVetoException

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMMemberLink

getQuantity

public Quantity getQuantity()

Supported API: true

See Also:

• EPMMemberLink

setQuantity

public void setQuantity(Quantity quantity)

Supported API: true

See Also:

• EPMMemberLink

getUsedBy

public EPMDocument getUsedBy()

Supported API: true

Overrides:

getUsedBy in class _IteratedUsageLink

See Also:

• EPMMemberLink
• IteratedUsageLink

setUsedBy

public void setUsedBy(EPMDocument the_usedBy)
               throws WTPropertyVetoException

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMMemberLink
• IteratedUsageLink

getUses

public EPMDependencyMaster getUses()

Supported API: true

Overrides:

getUses in class _IteratedUsageLink

See Also:

• EPMMemberLink
• IteratedUsageLink

setUses

public void setUses(EPMDependencyMaster the_uses)
             throws WTPropertyVetoException

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMMemberLink
• IteratedUsageLink

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

getFilteredStatus

public FilteredStatus getFilteredStatus()

Filtered status as calculated by the filter delegates.

Supported API: true

Specified by:

getFilteredStatus in interface _Filterable

See Also:

• Filterable

setFilteredStatus

public void setFilteredStatus(FilteredStatus filteredStatus)

Filtered status as calculated by the filter delegates.

Supported API: true

Specified by:

setFilteredStatus in interface _Filterable

See Also:

• Filterable