wt.epm.structure
Class EPMMemberLink

java.lang.Object
  wt.fc.WTObject
      wt.fc.ObjectToObjectLink
          wt.vc.struct.IteratedUsageLink
              wt.epm.structure.EPMMemberLink

All Implemented Interfaces:

Archiveable, BinaryLink, DisplayIdentification, EPMDependencyLink, EPMObject, Externalizable, IBAHolder, Link, NetFactor, ObjectMappable, OccurrenceableLink, Persistable, Serializable, Typed

public final class EPMMemberLink

extends IteratedUsageLink

implements EPMDependencyLink, OccurrenceableLink, Archiveable, Externalizable

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

private static int	AS_STORED_CHILD_NAME_UPPER_LIMIT
private String	asStoredChildName
private static String	CLASSNAME
static String	COMP_LAYER_IDX Label for the attribute.
static String	COMP_NUMBER Label for the attribute.
static String	COMP_REV_NUMBER Label for the attribute.
private int	compLayerIdx
private int	compNumber
private int	compRevNumber
private int	depType
private static String	EPMRESOURCE
static long	EXTERNALIZATION_VERSION_UID
private boolean	hasIBAValues
private Integer	identifier
static String	IDENTIFIER Label for the attribute; an integer identifier that an application may assign to an EPMMemberLink.
private String	name
static String	NAME Label for the attribute; a name that an application may give to an EPMMemberLink.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private boolean	placed
static String	PLACED Label for the attribute; Signifies whether or not this member has been placed by the application.
private Quantity	quantity
static String	QUANTITY Label for the attribute.
static long	R70_EXTERNALIZATION_VERSION_UID
static String	REFERENCE_CONTROL Label for the attribute.
private EPMCADReferenceControl	referenceControl
private boolean	required
private static String	RESOURCE
(package private) static long	serialVersionUID
private boolean	suppressed
static String	SUPPRESSED Label for the attribute.
private AttributeContainer	theAttributeContainer
private Transform	transform
static String	TRANSFORM Label for the attribute.
private TypeDefinitionReference	typeDefinitionReference
private static int	UNIQUE_NDID_UPPER_LIMIT
private long	uniqueLinkID
private String	uniqueNDId
static String	USED_BY_ROLE Label for the attribute.
static String	USES_ROLE Label for the attribute.
private Vector	usesOccurrenceVector

Fields inherited from class wt.fc.ObjectToObjectLink

ROLE_AOBJECT_REF, ROLE_BOBJECT_REF

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.epm.structure.EPMDependencyLink

AS_STORED_CHILD_NAME, DEP_TYPE, HAS_IBAVALUES, REQUIRED, UNIQUE_LINK_ID, UNIQUE_NDID

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

Fields inherited from interface wt.occurrence.OccurrenceableLink

USES_OCCURRENCE_VECTOR

Fields inherited from interface wt.fc.BinaryLink

ALL_ROLES, BOTH_ROLES, ROLE_AOBJECT_REF, ROLE_AOBJECT_ROLE, ROLE_BOBJECT_REF, ROLE_BOBJECT_ROLE

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

EPMMemberLink()

Method Summary

private void	asStoredChildNameValidate(String a_AsStoredChildName)
void	checkAttributes() Validates the attributes on this EPM Member Link.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getAsStoredChildName() Gets the value of the attribute: AS_STORED_CHILD_NAME.
AttributeContainer	getAttributeContainer() Gets the object for the association that plays role: ATTRIBUTE_CONTAINER.
EPMAuthoringAppType	getAuthoringApplication() Gets the value of the attribute: AUTHORING_APPLICATION.
int	getCompLayerIdx() Gets the value of the attribute: COMP_LAYER_IDX.
int	getCompNumber() Gets the value of the attribute: COMP_NUMBER.
int	getCompRevNumber() Gets the value of the attribute: COMP_REV_NUMBER.
String	getConceptualClassname() Deprecated.
int	getDepType() Gets the value of the attribute: DEP_TYPE.
Integer	getIdentifier() Gets the value of the attribute: IDENTIFIER.
String	getName() Gets the value of the attribute: NAME.
EPMApplicationType	getOwnerApplication() Gets the value of the attribute: OWNER_APPLICATION.
Quantity	getQuantity() Gets the object for the association that plays role: QUANTITY.
EPMCADReferenceControl	getReferenceControl() Gets the object for the association that plays role: REFERENCE_CONTROL.
Transform	getTransform() Gets the object for the association that plays role: TRANSFORM.
TypeDefinitionReference	getTypeDefinitionReference() Gets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.
long	getUniqueLinkID() Gets the value of the attribute: UNIQUE_LINK_ID.
String	getUniqueNDId() Gets the value of the attribute: UNIQUE_NDID.
Vector	getUsesOccurrenceVector() Gets the value of the attribute: USES_OCCURRENCE_VECTOR.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
boolean	hasTransform() Returns whether or not this member link has a transform.
protected void	initialize(EPMDocument usedBy, EPMDocumentMaster uses)
protected void	initialize(EPMDocument usedBy, EPMDocumentMaster uses, String asStoredChildName, int depType) Supports initialization, following construction of an instance.
boolean	isHasIBAValues() Gets the value of the attribute: HAS_IBAVALUES.
boolean	isPlaced() Gets the value of the attribute: PLACED.
boolean	isRequired() Gets the value of the attribute: REQUIRED.
boolean	isSuppressed() Gets the value of the attribute: SUPPRESSED.
private void	nameValidate(String a_Name)
static EPMMemberLink	newEPMMemberLink(EPMDocument usedBy, EPMDocumentMaster uses) Constructs an EPMMemberLink.
static EPMMemberLink	newEPMMemberLink(EPMDocument usedBy, EPMDocumentMaster uses, String asStoredChildName, int depType) Constructs an EPMMemberLink.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(EPMMemberLink thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAsStoredChildName(String a_AsStoredChildName) Sets the value of the attribute: AS_STORED_CHILD_NAME.
void	setAttributeContainer(AttributeContainer a_AttributeContainer) Sets the object for the association that plays role: ATTRIBUTE_CONTAINER.
void	setCompLayerIdx(int a_CompLayerIdx) Sets the value of the attribute: COMP_LAYER_IDX.
void	setCompNumber(int a_CompNumber) Sets the value of the attribute: COMP_NUMBER.
void	setCompRevNumber(int a_CompRevNumber) Sets the value of the attribute: COMP_REV_NUMBER.
void	setDepType(int a_DepType) Sets the value of the attribute: DEP_TYPE.
protected void	setHasIBAValues(boolean a_HasIBAValues) Sets the value of the attribute: HAS_IBAVALUES.
void	setIdentifier(int a_Identifier) Sets the identifier on this EPMMemberLink.
void	setIdentifier(Integer a_Identifier) Sets the value of the attribute: IDENTIFIER.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setPlaced(boolean a_Placed) Sets the value of the attribute: PLACED.
void	setQuantity(Quantity a_Quantity) Sets the object for the association that plays role: QUANTITY.
void	setReferenceControl(EPMCADReferenceControl a_ReferenceControl) Sets the object for the association that plays role: REFERENCE_CONTROL.
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.
void	setTypeDefinitionReference(TypeDefinitionReference a_TypeDefinitionReference) Sets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.
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.
void	setUsedBy(Iterated usedBy) Sets the object for the association that plays role: USED_BY_ROLE.
void	setUses(Mastered uses) Sets the object for the association that plays role: USES_ROLE.
void	setUsesOccurrenceVector(Vector a_UsesOccurrenceVector) Sets the value of the attribute: USES_OCCURRENCE_VECTOR.
private void	typeDefinitionReferenceValidate(TypeDefinitionReference a_TypeDefinitionReference)
private void	uniqueLinkIDValidate(long a_UniqueLinkID)
private void	uniqueNDIdValidate(String a_UniqueNDId)
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.vc.struct.IteratedUsageLink

getUsedBy, getUses, readVersion

Methods inherited from class wt.fc.ObjectToObjectLink

appendJoinCriteria, appendRoleCriteria, duplicate, getAllObjects, getJoinValues, getLinkInfo, getObject, getOtherObject, getRemoteRoleAObjectId, getRemoteRoleBObjectId, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, getRoleIdName, getRoleObject, initialize, isRoleANonpersistentProxy, isRoleBNonpersistentProxy, readVersion, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef, setRoleObject

Methods inherited from class wt.fc.WTObject

finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.Persistable

getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Methods inherited from interface wt.fc.BinaryLink

getLinkInfo, getObject, getOtherObject, getRole, getRoleAObject, getRoleAObjectId, getRoleAObjectRef, getRoleBObject, getRoleBObjectId, getRoleBObjectRef, setRoleAObject, setRoleAObjectRef, setRoleBObject, setRoleBObjectRef

Methods inherited from interface wt.fc.Link

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

USED_BY_ROLE

public static final String USED_BY_ROLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

USES_ROLE

public static final String USES_ROLE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

SUPPRESSED

public static final String SUPPRESSED

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

suppressed

private boolean suppressed

NAME

public static final String NAME

Label for the attribute; a name that an application may give to an EPMMemberLink.

Supported API: false

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

IDENTIFIER

public static final String IDENTIFIER

Label for the attribute; an integer identifier that an application may assign to an EPMMemberLink.

Supported API: false

See Also:

Constant Field Values

identifier

private Integer identifier

PLACED

public static final String PLACED

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

Supported API: false

See Also:

Constant Field Values

placed

private boolean placed

COMP_NUMBER

public static final String COMP_NUMBER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

compNumber

private int compNumber

COMP_REV_NUMBER

public static final String COMP_REV_NUMBER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

compRevNumber

private int compRevNumber

COMP_LAYER_IDX

public static final String COMP_LAYER_IDX

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

compLayerIdx

private int compLayerIdx

TRANSFORM

public static final String TRANSFORM

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

transform

private Transform transform

REFERENCE_CONTROL

public static final String REFERENCE_CONTROL

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

referenceControl

private EPMCADReferenceControl referenceControl

QUANTITY

public static final String QUANTITY

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

quantity

private Quantity quantity

AS_STORED_CHILD_NAME_UPPER_LIMIT

private static int AS_STORED_CHILD_NAME_UPPER_LIMIT

asStoredChildName

private String asStoredChildName

depType

private int depType

required

private boolean required

uniqueLinkID

private long uniqueLinkID

UNIQUE_NDID_UPPER_LIMIT

private static int UNIQUE_NDID_UPPER_LIMIT

uniqueNDId

private String uniqueNDId

hasIBAValues

private boolean hasIBAValues

typeDefinitionReference

private TypeDefinitionReference typeDefinitionReference

theAttributeContainer

private AttributeContainer theAttributeContainer

usesOccurrenceVector

private Vector usesOccurrenceVector

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

EPMRESOURCE

private static final String EPMRESOURCE

See Also:

Constant Field Values

R70_EXTERNALIZATION_VERSION_UID

public static final long R70_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

EPMMemberLink

public EPMMemberLink()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class IteratedUsageLink

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class IteratedUsageLink

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(EPMMemberLink thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class IteratedUsageLink

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class IteratedUsageLink

Parameters:

input -

Throws:

SQLException

DatastoreException

setUsedBy

public void setUsedBy(Iterated usedBy)
               throws WTPropertyVetoException

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

Supported API: false

Overrides:

setUsedBy in class IteratedUsageLink

Parameters:

usedBy -

Throws:

WTPropertyVetoException

setUses

public void setUses(Mastered uses)
             throws WTPropertyVetoException

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

Supported API: true

Overrides:

setUses in class IteratedUsageLink

Parameters:

uses -

Throws:

WTPropertyVetoException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

isSuppressed

public boolean isSuppressed()

Gets the value of the attribute: SUPPRESSED.

Supported API: false

Returns:

boolean

setSuppressed

public void setSuppressed(boolean a_Suppressed)
                   throws WTPropertyVetoException

Sets the value of the attribute: SUPPRESSED.

Supported API: false

Parameters:

a_Suppressed -

Throws:

WTPropertyVetoException

getName

public String getName()

Gets the value of the attribute: NAME. a name that an application may give to an EPMMemberLink.

Supported API: false

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. a name that an application may give to an EPMMemberLink.

Supported API: false

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getIdentifier

public Integer getIdentifier()

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

Supported API: false

Returns:

Integer

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

Parameters:

a_Identifier -

Throws:

WTPropertyVetoException

isPlaced

public boolean isPlaced()

Gets the value of the attribute: PLACED. 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.

Supported API: false

Returns:

boolean

setPlaced

public void setPlaced(boolean a_Placed)
               throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_Placed -

Throws:

WTPropertyVetoException

getCompNumber

public int getCompNumber()

Gets the value of the attribute: COMP_NUMBER.

Supported API: false

Returns:

int

setCompNumber

public void setCompNumber(int a_CompNumber)
                   throws WTPropertyVetoException

Sets the value of the attribute: COMP_NUMBER.

Supported API: false

Parameters:

a_CompNumber -

Throws:

WTPropertyVetoException

getCompRevNumber

public int getCompRevNumber()

Gets the value of the attribute: COMP_REV_NUMBER.

Supported API: false

Returns:

int

setCompRevNumber

public void setCompRevNumber(int a_CompRevNumber)
                      throws WTPropertyVetoException

Sets the value of the attribute: COMP_REV_NUMBER.

Supported API: false

Parameters:

a_CompRevNumber -

Throws:

WTPropertyVetoException

getCompLayerIdx

public int getCompLayerIdx()

Gets the value of the attribute: COMP_LAYER_IDX.

Supported API: false

Returns:

int

setCompLayerIdx

public void setCompLayerIdx(int a_CompLayerIdx)
                     throws WTPropertyVetoException

Sets the value of the attribute: COMP_LAYER_IDX.

Supported API: false

Parameters:

a_CompLayerIdx -

Throws:

WTPropertyVetoException

getTransform

public Transform getTransform()

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

Supported API: true

Returns:

Transform

setTransform

public void setTransform(Transform a_Transform)
                  throws WTPropertyVetoException

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

Supported API: true

Parameters:

a_Transform -

Throws:

WTPropertyVetoException

getReferenceControl

public EPMCADReferenceControl getReferenceControl()

Gets the object for the association that plays role: REFERENCE_CONTROL.

Supported API: false

Returns:

EPMCADReferenceControl

setReferenceControl

public void setReferenceControl(EPMCADReferenceControl a_ReferenceControl)
                         throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_ReferenceControl -

Throws:

WTPropertyVetoException

getQuantity

public Quantity getQuantity()

Gets the object for the association that plays role: QUANTITY.

Supported API: true

Returns:

Quantity

setQuantity

public void setQuantity(Quantity a_Quantity)

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

Supported API: true

Parameters:

a_Quantity -

newEPMMemberLink

public static EPMMemberLink newEPMMemberLink(EPMDocument usedBy,
                                             EPMDocumentMaster 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,
                          EPMDocumentMaster 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,
                                             EPMDocumentMaster 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

Overrides:

checkAttributes in class WTObject

Throws:

InvalidAttributeException

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

asStoredChildNameValidate

private void asStoredChildNameValidate(String a_AsStoredChildName)
                                throws WTPropertyVetoException

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

uniqueLinkIDValidate

private void uniqueLinkIDValidate(long a_UniqueLinkID)
                           throws WTPropertyVetoException

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

uniqueNDIdValidate

private void uniqueNDIdValidate(String a_UniqueNDId)
                         throws WTPropertyVetoException

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

Specified by:

isHasIBAValues in interface EPMDependencyLink

Returns:

boolean

setHasIBAValues

protected void setHasIBAValues(boolean a_HasIBAValues)

Sets 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

Parameters:

a_HasIBAValues -

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

getTypeDefinitionReference

public TypeDefinitionReference getTypeDefinitionReference()

Gets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.

Supported API: false

Specified by:

getTypeDefinitionReference in interface Typed

Returns:

TypeDefinitionReference

setTypeDefinitionReference

public void setTypeDefinitionReference(TypeDefinitionReference a_TypeDefinitionReference)
                                throws WTPropertyVetoException

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

Supported API: false

Specified by:

setTypeDefinitionReference in interface Typed

Parameters:

a_TypeDefinitionReference -

Throws:

WTPropertyVetoException

typeDefinitionReferenceValidate

private void typeDefinitionReferenceValidate(TypeDefinitionReference a_TypeDefinitionReference)
                                      throws WTPropertyVetoException

Parameters:

a_TypeDefinitionReference -

Throws:

WTPropertyVetoException

getAttributeContainer

public AttributeContainer getAttributeContainer()

Gets the object for the association that plays role: ATTRIBUTE_CONTAINER.

Supported API: false

Specified by:

getAttributeContainer in interface IBAHolder

Returns:

AttributeContainer

setAttributeContainer

public void setAttributeContainer(AttributeContainer a_AttributeContainer)

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

Supported API: false

Specified by:

setAttributeContainer in interface IBAHolder

Parameters:

a_AttributeContainer -

getUsesOccurrenceVector

public Vector getUsesOccurrenceVector()

Gets the value of the attribute: USES_OCCURRENCE_VECTOR. Each element of this non-persistent Vector contains UsesOccurrences, each of which may contain a PathOccurrence. Note that any implementation of this interface must provide server-side APIs that specifically populate this Vector, otherwise it will be null.

Supported API: true

Specified by:

getUsesOccurrenceVector in interface OccurrenceableLink

Returns:

Vector

setUsesOccurrenceVector

public void setUsesOccurrenceVector(Vector a_UsesOccurrenceVector)

Sets the value of the attribute: USES_OCCURRENCE_VECTOR. Each element of this non-persistent Vector contains UsesOccurrences, each of which may contain a PathOccurrence. Note that any implementation of this interface must provide server-side APIs that specifically populate this Vector, otherwise it will be null.

Supported API: true

Specified by:

setUsesOccurrenceVector in interface OccurrenceableLink

Parameters:

a_UsesOccurrenceVector -

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class IteratedUsageLink

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class IteratedUsageLink

Returns:

int

initialize

protected void initialize(EPMDocument usedBy,
                          EPMDocumentMaster uses)
                   throws WTException

Throws:

WTException