wt.epm
Class EPMDocumentMaster

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Master
          wt.epm.EPMDocumentMaster

All Implemented Interfaces:

Externalizable, Serializable, wt.build.BuildSourceMaster, Document, DocumentMaster, EPMObject, wt.fc.BusinessInformation, Identified, NetFactor, ObjectMappable, Persistable, UniquelyIdentified, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, wt.iba.value.IBAHolder, DisplayIdentification, WTContained, wt.inf.container.WTContainedFilterable, WTContainedIdentified, wt.org.electronicIdentity.ElectronicallySignable, OrganizationOwned, OrganizationOwnedImpl, OrganizationOwnedMaster, wt.recent.RecentlyVisited, wt.representation.RepresentableMaster, wt.representation.RepresentablesAndMasters, wt.type.FlexTyped, wt.type.Typed, wt.ufid.Federatable, Mastered

public class EPMDocumentMaster
extends Master
implements DocumentMaster, UniquelyIdentified, EPMObject, wt.ufid.Federatable, OrganizationOwnedMaster, WTContainedIdentified, wt.type.Typed, wt.build.BuildSourceMaster, wt.representation.RepresentableMaster, wt.inf.container.WTContainedFilterable, Externalizable

The Master of an EPMDocument. It has a name and number, the latter of which must be unique, and is paired to a EPMDocument.

Use the newEPMDocumentMaster static factory method(s), not the EPMDocumentMaster 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	AUTHORING_APPLICATION Label for the attribute; Indicates that the named application authored the object.
static String	CADNAME Label for the attribute; TheCAD Name of the document.t.
static String	DEFAULT_UNIT Label for the attribute; The default unit of measurement assigned to the document when it is used in a structure.
static String	DOC_SUB_TYPE Label for the attribute.
static String	DOC_TYPE Label for the attribute.
static String	NAME Label for the attribute; The name of the document.
static String	NUMBER Label for the attribute; The number attribute represents the number for this document and all of its versions.
static String	OWNER_APPLICATION Label for the attribute; Indicate that the named application owns the object.

Fields inherited from interface wt.org.OrganizationOwnedImpl

ORGANIZATION_REFERENCE

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION, ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Method Summary

void	checkAttributes() Validates the values of the required attributes.
EPMAuthoringAppType	getAuthoringApplication() Gets the value of the attribute: AUTHORING_APPLICATION.
String	getCADName() Gets the value of the attribute: CADNAME.
QuantityUnit	getDefaultUnit() Gets the object for the association that plays role: DEFAULT_UNIT.
EPMDocSubType	getDocSubType() Gets the object for the association that plays role: DOC_SUB_TYPE.
EPMDocumentType	getDocType() Gets the object for the association that plays role: DOC_TYPE.
String	getName() Gets the value of the attribute: NAME.
String	getNumber() Gets the value of the attribute: NUMBER.
WTOrganization	getOrganization() Gets the value of the attribute: ORGANIZATION.
String	getOrganizationCodingSystem() Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM.
String	getOrganizationName() Gets the value of the attribute: ORGANIZATION_NAME.
WTPrincipalReference	getOrganizationReference() Gets the value of the attribute: ORGANIZATION_REFERENCE.
String	getOrganizationUniqueIdentifier() Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER.
EPMApplicationType	getOwnerApplication() Gets the value of the attribute: OWNER_APPLICATION.
void	setAuthoringApplication(EPMAuthoringAppType a_AuthoringApplication) Sets the value of the attribute: AUTHORING_APPLICATION.
void	setCADName(String a_CADName) Sets the value of the attribute: CADNAME.
void	setDefaultUnit(QuantityUnit a_DefaultUnit) Sets the object for the association that plays role: DEFAULT_UNIT.
void	setDocSubType(EPMDocSubType a_DocSubType) Sets the object for the association that plays role: DOC_SUB_TYPE.
void	setDocType(EPMDocumentType a_DocType) Sets the object for the association that plays role: DOC_TYPE.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setNumber(String a_Number) Sets the value of the attribute: NUMBER.
void	setOrganization(WTOrganization a_Organization) Sets the value of the attribute: ORGANIZATION.
void	setOrganizationReference(WTPrincipalReference a_OrganizationReference) Sets the value of the attribute: ORGANIZATION_REFERENCE.
void	setOwnerApplication(EPMApplicationType a_OwnerApplication) Sets the value of the attribute: OWNER_APPLICATION.

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

NUMBER

public static final String NUMBER

Label for the attribute; The number attribute represents the number for this document and all of its versions. Conceptually on the EPMSocument, it is actually implemented on the master.

Supported API: true

See Also:

Constant Field Values

NAME

public static final String NAME

Label for the attribute; The name of the document.

Supported API: true

See Also:

Constant Field Values

CADNAME

public static final String CADNAME

Label for the attribute; TheCAD Name of the document.t.

Supported API: true

See Also:

Constant Field Values

OWNER_APPLICATION

public static final String OWNER_APPLICATION

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

See Also:

Constant Field Values

AUTHORING_APPLICATION

public static final String AUTHORING_APPLICATION

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

See Also:

Constant Field Values

DOC_TYPE

public static final String DOC_TYPE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

DOC_SUB_TYPE

public static final String DOC_SUB_TYPE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

DEFAULT_UNIT

public static final String DEFAULT_UNIT

Label for the attribute; The default unit of measurement assigned to the document when it is used in a structure.

Supported API: true

See Also:

Constant Field Values

Method Detail

getNumber

public String getNumber()

Gets the value of the attribute: NUMBER. The number attribute represents the number for this document and all of its versions. Conceptually on the EPMSocument, it is actually implemented on the master.

Supported API: true

Returns:

String

setNumber

public void setNumber(String a_Number)
               throws WTPropertyVetoException

Sets the value of the attribute: NUMBER. The number attribute represents the number for this document and all of its versions. Conceptually on the EPMSocument, it is actually implemented on the master.

Supported API: true

Parameters:

a_Number -

Throws:

WTPropertyVetoException

getName

public String getName()

Gets the value of the attribute: NAME. The name of the document.

Supported API: true

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. The name of the document.

Supported API: true

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getCADName

public String getCADName()

Gets the value of the attribute: CADNAME. TheCAD Name of the document.t.

Supported API: true

Returns:

String

setCADName

public void setCADName(String a_CADName)
                throws WTPropertyVetoException

Sets the value of the attribute: CADNAME. TheCAD Name of the document.t.

Supported API: true

Parameters:

a_CADName -

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

setOwnerApplication

public void setOwnerApplication(EPMApplicationType a_OwnerApplication)
                         throws WTPropertyVetoException

Sets 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

Parameters:

a_OwnerApplication -

Throws:

WTPropertyVetoException

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

setAuthoringApplication

public void setAuthoringApplication(EPMAuthoringAppType a_AuthoringApplication)
                             throws WTPropertyVetoException

Sets 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

Parameters:

a_AuthoringApplication -

Throws:

WTPropertyVetoException

getDocType

public EPMDocumentType getDocType()

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

Supported API: true

Returns:

EPMDocumentType

setDocType

public void setDocType(EPMDocumentType a_DocType)
                throws WTPropertyVetoException

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

Supported API: true

Parameters:

a_DocType -

Throws:

WTPropertyVetoException

getDocSubType

public EPMDocSubType getDocSubType()

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

Supported API: true

Returns:

EPMDocSubType

setDocSubType

public void setDocSubType(EPMDocSubType a_DocSubType)
                   throws WTPropertyVetoException

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

Supported API: true

Parameters:

a_DocSubType -

Throws:

WTPropertyVetoException

getDefaultUnit

public QuantityUnit getDefaultUnit()

Gets the object for the association that plays role: DEFAULT_UNIT. The default unit of measurement assigned to the document when it is used in a structure.

Supported API: true

Returns:

QuantityUnit

setDefaultUnit

public void setDefaultUnit(QuantityUnit a_DefaultUnit)
                    throws WTPropertyVetoException

Sets the object for the association that plays role: DEFAULT_UNIT. The default unit of measurement assigned to the document when it is used in a structure.

Supported API: true

Parameters:

a_DefaultUnit -

Throws:

WTPropertyVetoException

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validates the values of the required attributes.

Supported API: true

Specified by:

checkAttributes in interface EPMObject

Throws:

InvalidAttributeException

getOrganizationReference

public WTPrincipalReference getOrganizationReference()

Gets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: true

Specified by:

getOrganizationReference in interface OrganizationOwned

Specified by:

getOrganizationReference in interface OrganizationOwnedImpl

Returns:

WTPrincipalReference

setOrganizationReference

public void setOrganizationReference(WTPrincipalReference a_OrganizationReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: true

Parameters:

a_OrganizationReference -

Throws:

WTPropertyVetoException

getOrganizationUniqueIdentifier

public String getOrganizationUniqueIdentifier()

Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER. The getter for this attribute delivers organization unique identifier.

Supported API: true

Specified by:

getOrganizationUniqueIdentifier in interface OrganizationOwned

Returns:

String

getOrganizationCodingSystem

public String getOrganizationCodingSystem()

Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM. The getter for this attribute delivers organization coding system.

Supported API: true

Specified by:

getOrganizationCodingSystem in interface OrganizationOwned

Returns:

String

getOrganizationName

public String getOrganizationName()

Gets the value of the attribute: ORGANIZATION_NAME. The getter for this attribute delivers organization name.

Supported API: true

Specified by:

getOrganizationName in interface OrganizationOwned

Returns:

String

getOrganization

public WTOrganization getOrganization()

Gets the value of the attribute: ORGANIZATION.

Supported API: true

Specified by:

getOrganization in interface OrganizationOwned

Returns:

WTOrganization

setOrganization

public void setOrganization(WTOrganization a_Organization)
                     throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION.

Supported API: true

Parameters:

a_Organization -

Throws:

WTPropertyVetoException