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

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

@GenAsBinaryLink(superClass=IteratedUsageLink.class,interfaces={EPMDependencyLink.class,wt.fc.archive.Archiveable.class,EPMStructureAnnotatable.class,wt.generic.GenericizableLink.class,wt.epm.structure.EPMIDSpaceContainer.class,Releasable.class},versions=6929983481934594105L,properties={@GeneratedProperty(name="suppressed",type=boolean.class,initialValue="false",supportedAPI=PUBLIC),@GeneratedProperty(name="name",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="a name that an application may give to an EPMMemberLink."),@GeneratedProperty(name="identifier",type=java.lang.Integer.class,supportedAPI=PUBLIC,javaDoc="an integer identifier that an application may assign to an EPMMemberLink."),@GeneratedProperty(name="identifierSpaceName",type=java.lang.String.class,supportedAPI=PUBLIC),@GeneratedProperty(name="placed",type=boolean.class,initialValue="false",javaDoc="Signifies whether or not this member has been placed by the application. The application may choose to place the member but not publish its transform. In that case, this flag is set to true but the member link will not have a transform. Use hasTransform() to determine whether or not the member link actually has a transform."),@GeneratedProperty(name="compNumber",type=int.class,initialValue="-1"),@GeneratedProperty(name="compRevNumber",type=int.class,initialValue="-1"),@GeneratedProperty(name="compLayerIdx",type=int.class,initialValue="-1"),@GeneratedProperty(name="substitute",type=boolean.class,initialValue="false",javaDoc="Indicates a substitute component"),@GeneratedProperty(name="fixed",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="Indicates a fixed component"),@GeneratedProperty(name="sourceIdentifier",type=java.lang.Integer.class,supportedAPI=DEPRECATED,initialValue="null",javaDoc="Component id of source cad document.",accessors=@PropertyAccessors(getAccess=PRIVATE,setAccess=PRIVATE)),@GeneratedProperty(name="annotated",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="Indicates whether the member link is annotated."),@GeneratedProperty(name="fabricated",type=boolean.class,initialValue="false",javaDoc="An internal flag indicating whether the link is fabricated.  Persisting the fabricated link object is not allowed.",accessors=@PropertyAccessors(setAccess=PROTECTED),columnProperties=@ColumnProperties(persistent=false)),@GeneratedProperty(name="transform",type=Transform.class,supportedAPI=PUBLIC),@GeneratedProperty(name="referenceControl",type=wt.epm.EPMCADReferenceControl.class),@GeneratedProperty(name="modelItemOwnerId",type=java.lang.String.class,javaDoc="UniqueId of the owner pattern/group. The default value is null"),@GeneratedProperty(name="modelItemOwnerType",type=ModelItemType.class,javaDoc="ModelItemType of the owner pattern/group. The default value is null"),@GeneratedProperty(name="quantity",type=Quantity.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={}),constraints=@PropertyConstraints(required=true))},depthLock=7,roleA=@GeneratedRole(name="usedBy",type=EPMDocument.class,cardinality=ONE_TO_MANY),roleB=@GeneratedRole(name="uses",type=EPMDependencyMaster.class,supportedAPI=PUBLIC,cardinality=ONE_TO_MANY,owner=false),tableProperties=@TableProperties(compositeIndex1="+roleBObjectRef.key.id",compositeIndex2="+roleAObjectRef.key.id",tableName="EPMMemberLink",oracleTableSize=HUGE))
public final class EPMMemberLink
extends _EPMMemberLink

A member link always has a quantity. If a member link has a transform, its quantity must be one and its placed flag must be true.

Use the newEPMMemberLink static factory method(s), not the EPMMemberLink 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 class wt.epm.structure._EPMMemberLink

ANNOTATED, FIXED, IDENTIFIER, IDENTIFIER_SPACE_NAME, NAME, QUANTITY, SUPPRESSED, TRANSFORM

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
void	checkAttributes()	Validates the attributes on this EPM Member Link.
EPMAuthoringAppType	getAuthoringApplication()	Gets the value of the attribute: AUTHORING_APPLICATION.
EPMApplicationType	getOwnerApplication()	Gets the value of the attribute: OWNER_APPLICATION.
boolean	hasTransform()	Returns whether or not this member link has a transform.
protected void	initialize(EPMDocument usedBy, EPMDependencyMaster uses, String asStoredChildName, int depType)	Supports initialization, following construction of an instance.
static EPMMemberLink	newEPMMemberLink(EPMDocument usedBy, EPMDependencyMaster uses)	Constructs an EPMMemberLink.
static EPMMemberLink	newEPMMemberLink(EPMDocument usedBy, EPMDependencyMaster uses, String asStoredChildName, int depType)	Constructs an EPMMemberLink.
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	setIdentifier(int a_Identifier)	Sets the identifier on this EPMMemberLink.
void	setIdentifier(Integer a_Identifier)	Sets the value of the attribute: IDENTIFIER.
void	setRequired(boolean a_Required)	Sets the value of the attribute: REQUIRED.
void	setSuppressed(boolean a_Suppressed)	Sets the value of the attribute: SUPPRESSED.
void	setTransform(Transform a_Transform)	Sets the object for the association that plays role: TRANSFORM.

Methods inherited from class wt.epm.structure._EPMMemberLink

getAsStoredChildName, getDepType, getFilteredStatus, getIdentifier, getIdentifierSpaceName, getName, getQuantity, getTransform, getUniqueLinkID, getUniqueNDId, getUsedBy, getUses, isAnnotated, isFixed, isRequired, isSuppressed, setAnnotated, setFilteredStatus, setFixed, setIdentifierSpaceName, setQuantity, setUniqueLinkID, setUniqueNDId, setUsedBy, setUses

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.fc.Link

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

Method Details

setSuppressed

public void setSuppressed(boolean a_Suppressed)
                   throws WTPropertyVetoException

Sets the value of the attribute: SUPPRESSED.

Supported API: true

Overrides:

setSuppressed in class _EPMMemberLink

Parameters:

a_Suppressed -

Throws:

WTPropertyVetoException

See Also:

• EPMMemberLink

setIdentifier

public void setIdentifier(Integer a_Identifier)
                   throws WTPropertyVetoException

Sets the value of the attribute: IDENTIFIER. an integer identifier that an application may assign to an EPMMemberLink.

Supported API: true

Overrides:

setIdentifier in class _EPMMemberLink

Parameters:

a_Identifier -

Throws:

WTPropertyVetoException

See Also:

• EPMMemberLink

setTransform

public void setTransform(Transform a_Transform)
                  throws WTPropertyVetoException

Sets the object for the association that plays role: TRANSFORM.

Supported API: true

Overrides:

setTransform in class _EPMMemberLink

Parameters:

a_Transform -

Throws:

WTPropertyVetoException

See Also:

• EPMMemberLink

newEPMMemberLink

public static EPMMemberLink newEPMMemberLink(EPMDocument usedBy,
 EPMDependencyMaster uses,
 String asStoredChildName,
 int depType)
                                      throws WTException

Constructs an EPMMemberLink.

By default, this constructor sets 'required' to false, 'suppressed' to false, 'name' to null, 'identifier' to null, 'quantity' to 1, 'placed' to false and 'transform' to null.

Supported API: true

Parameters:

usedBy -

uses -

asStoredChildName -

depType -

Returns:

EPMMemberLink

Throws:

WTException

initialize

protected void initialize(EPMDocument usedBy,
 EPMDependencyMaster uses,
 String asStoredChildName,
 int depType)
                   throws WTException

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

Supported API: true

Parameters:

usedBy -

uses -

asStoredChildName -

depType -

Throws:

WTException

newEPMMemberLink

public static EPMMemberLink newEPMMemberLink(EPMDocument usedBy,
 EPMDependencyMaster uses)
                                      throws WTException

Constructs an EPMMemberLink.

By default, this constructor sets 'asStoredChildName' to null, 'depType' to UNSPECIFIED, 'required' to false, 'suppressed' to false, 'name' to null, 'identifier' to null, 'quantity' to 1, 'placed' to false and 'transform' to null.

Supported API: true

Parameters:

usedBy -

uses -

Returns:

EPMMemberLink

Throws:

WTException

hasTransform

public boolean hasTransform()

Returns whether or not this member link has a transform. The application may choose to place the member but not publish its transform. In that case, this method will return false while isPlaced() will return true.

Supported API: true

Returns:

boolean

setIdentifier

public void setIdentifier(int a_Identifier)
                   throws WTPropertyVetoException

Sets the identifier on this EPMMemberLink.

Supported API: true

Parameters:

a_Identifier -

Throws:

WTPropertyVetoException

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validates the attributes on this EPM Member Link.

In particular, this method enforces the following rules: a) If a member link has a transform, its quantity must be one and its placed flag must be true.

Supported API: true

Specified by:

checkAttributes in interface EPMObject

Specified by:

checkAttributes in interface Persistable

Overrides:

checkAttributes in class WTObject

Throws:

InvalidAttributeException

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 _EPMMemberLink

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 _EPMMemberLink

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 _EPMMemberLink

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