wt.epm.structure
Class EPMContainedIn

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

All Implemented Interfaces:

Externalizable, Serializable, EPMObject, wt.fc.archive.Archiveable, BinaryLink, Link, NetFactor, ObjectMappable, Persistable, DisplayIdentification

public final class EPMContainedIn
extends ObjectToObjectLink
implements EPMObject, wt.fc.archive.Archiveable, Externalizable

A CAD file may contain multiple objects that an authoring application wants to expose as separate business objects (i.e. EPMDocuments). This relation associates two EPMDocuments where one holds an object contained in the other, such as a family instance and its family table.

Use the newEPMContainedIn static factory method(s), not the EPMContainedIn 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

static String	LOCKED Label for the attribute.
static String	VERIFY_STATUS Label for the attribute.

Fields inherited from interface wt.epm.EPMObject

AUTHORING_APPLICATION, OWNER_APPLICATION

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
EPMAuthoringAppType	getAuthoringApplication() Gets the value of the attribute: AUTHORING_APPLICATION.
EPMApplicationType	getOwnerApplication() Gets the value of the attribute: OWNER_APPLICATION.
int	getVerifyStatus() Gets the value of the attribute: VERIFY_STATUS.
boolean	isLocked() Gets the value of the attribute: LOCKED.
void	setLocked(boolean a_Locked) Sets the value of the attribute: LOCKED.
void	setVerifyStatus(int a_VerifyStatus) Sets the value of the attribute: VERIFY_STATUS.

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

Field Detail

VERIFY_STATUS

public static final String VERIFY_STATUS

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

LOCKED

public static final String LOCKED

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getVerifyStatus

public int getVerifyStatus()

Gets the value of the attribute: VERIFY_STATUS.

Supported API: true

Returns:

int

setVerifyStatus

public void setVerifyStatus(int a_VerifyStatus)
                     throws WTPropertyVetoException

Sets the value of the attribute: VERIFY_STATUS.

Supported API: true

Parameters:

a_VerifyStatus -

Throws:

WTPropertyVetoException

isLocked

public boolean isLocked()

Gets the value of the attribute: LOCKED.

Supported API: true

Returns:

boolean

setLocked

public void setLocked(boolean a_Locked)
               throws WTPropertyVetoException

Sets the value of the attribute: LOCKED.

Supported API: true

Parameters:

a_Locked -

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