Package wt.epm

Class _EPMDocumentMaster

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.enterprise._Master

wt.enterprise.Master

wt.epm._EPMDocumentMaster

All Implemented Interfaces:

Externalizable, Serializable, wt.build._BuildSourceMaster, wt.build.BuildSourceMaster, wt.doc._Document, wt.doc._DocumentMaster, Document, DocumentMaster, wt.epm._EPMObject, EPMObject, wt.epm.interfaces._EPMDependencyMaster, EPMDependencyMaster, wt.fc._Identified, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc._UniquelyIdentified, wt.fc.BusinessInformation, Identified, NetFactor, ObjectMappable, Persistable, UniquelyIdentified, wt.federation._FederatedLinkHolder, wt.federation._RemotelyLinkable, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, wt.generic._GenericizableMaster, wt.generic.GenericizableMaster, wt.iba.value._IBAHolder, wt.iba.value.IBAHolder, DisplayIdentification, wt.inf.container._WTContained, wt.inf.container._WTContainedFilterable, wt.inf.container._WTContainedIdentified, WTContained, wt.inf.container.WTContainedFilterable, WTContainedIdentified, wt.option._OptionSetAssignable, OptionSetAssignable, _OrganizationOwned, _OrganizationOwnedImpl, wt.org._OrganizationOwnedMaster, wt.org.electronicIdentity._ElectronicallySignable, wt.org.electronicIdentity.ElectronicallySignable, OrganizationOwned, OrganizationOwnedImpl, OrganizationOwnedMaster, wt.projmgmt.deliverable._MasteredSubjectOfDeliverable, wt.projmgmt.deliverable._SubjectOfDeliverable, wt.projmgmt.deliverable.MasteredSubjectOfDeliverable, wt.projmgmt.deliverable.SubjectOfDeliverable, wt.recent.RecentlyVisited, wt.representation._RepresentableMaster, wt.representation._RepresentablesAndMasters, wt.representation.RepresentableMaster, wt.representation.RepresentablesAndMasters, wt.type._Typed, wt.type._TypeManaged, wt.type.FlexTyped, wt.type.Typed, wt.type.TypeManaged, wt.ufid._Federatable, wt.ufid.Federatable, wt.vc._Mastered, Mastered

Direct Known Subclasses:

EPMDocumentMaster

public abstract 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, EPMDependencyMaster, wt.generic.GenericizableMaster, OptionSetAssignable, wt.projmgmt.deliverable.MasteredSubjectOfDeliverable, Externalizable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHORING_APPLICATION	Indicates that the named application authored the object.
static final String	CADNAME	TheCAD Name of the document.t.
static final String	DEFAULT_UNIT	The default unit of measurement assigned to the document when it is used in a structure.
static final String	DOC_SUB_TYPE	Supported API: true
static final String	DOC_TYPE	Supported API: true
static final String	NAME	The name of the document.
static final String	NUMBER	The number attribute represents the number for this document and all of its versions.
static final String	OWNER_APPLICATION	Indicate that the named application owns the object.

Fields inherited from class wt.enterprise.Master

OLD_FORMAT_VERSION_UID

Fields inherited from class wt.fc._WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.ufid._Federatable

FEDERATABLE_INFO

Fields inherited from interface wt.generic._GenericizableMaster

COLLAPSIBLE, GENERIC_TYPE

Fields inherited from interface wt.iba.value._IBAHolder

ATTRIBUTE_CONTAINER

Fields inherited from interface wt.vc._Mastered

SERIES

Fields inherited from interface wt.org._OrganizationOwned

ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Fields inherited from interface wt.org._OrganizationOwnedImpl

ORGANIZATION_REFERENCE

Fields inherited from interface wt.fc._Persistable

PERSIST_INFO

Fields inherited from interface wt.type._Typed

TYPE_DEFINITION_REFERENCE

Fields inherited from interface wt.inf.container._WTContained

CONTAINER, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Fields inherited from interface wt.epm.EPMObject

UNSPECIFIED

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION

Fields inherited from interface wt.fc.Persistable

IDENTITY, TYPE

Fields inherited from interface wt.projmgmt.deliverable.SubjectOfDeliverable

logger

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID

Method Summary

Modifier and Type	Method	Description
EPMAuthoringAppType	getAuthoringApplication()	Indicates that the named application authored the object.
String	getCADName()	TheCAD Name of the document.t.
QuantityUnit	getDefaultUnit()	The default unit of measurement assigned to the document when it is used in a structure.
EPMDocSubType	getDocSubType()	Supported API: true
EPMDocumentType	getDocType()	Supported API: true
String	getName()	The name of the document.
String	getNumber()	The number attribute represents the number for this document and all of its versions.
String	getOrganizationCodingSystem()	Supported API: true
String	getOrganizationName()	Supported API: true
WTPrincipalReference	getOrganizationReference()	Supported API: true
String	getOrganizationUniqueIdentifier()	Supported API: true
EPMApplicationType	getOwnerApplication()	Indicate that the named application owns the object.
void	setAuthoringApplication(EPMAuthoringAppType authoringApplication)	Indicates that the named application authored the object.
void	setCADName(String CADName)	TheCAD Name of the document.t.
void	setDefaultUnit(QuantityUnit defaultUnit)	The default unit of measurement assigned to the document when it is used in a structure.
void	setDocSubType(EPMDocSubType docSubType)	Supported API: true
void	setDocType(EPMDocumentType docType)	Supported API: true
void	setName(String name)	The name of the document.
void	setNumber(String number)	The number attribute represents the number for this document and all of its versions.
void	setOrganizationReference(WTPrincipalReference organizationReference)	Supported API: true
void	setOwnerApplication(EPMApplicationType ownerApplication)	Indicate that the named application owns the object.

Methods inherited from class wt.enterprise.Master

getBusinessType, getIdentity, setSeries

Methods inherited from class wt.enterprise._Master

getSeries, readVersion, super_readExternal_Master, super_readVersion_Master, super_writeExternal_Master

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, getDisplayIdentifier, getDisplayIdentity, getDisplayType, initialize, toString

Methods inherited from class wt.fc._WTObject

equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.vc._Mastered

getSeries, setSeries

Methods inherited from interface wt.fc._Persistable

getPersistInfo, setPersistInfo

Methods inherited from interface wt.epm.EPMObject

checkAttributes

Methods inherited from interface wt.type.FlexTyped

getFlexTypeIdPath, getTypeDefinitionInfo, getValue, setValue

Methods inherited from interface wt.fc.Identified

getIdentificationObject

Methods inherited from interface wt.org.OrganizationOwned

getOrganization, setOrganization

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity

Field Details

NUMBER

public static final String 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

See Also:

• EPMDocumentMaster
• Constant Field Values

NAME

public static final String NAME

The name of the document.

Supported API: true

See Also:

• EPMDocumentMaster
• Constant Field Values

CADNAME

public static final String CADNAME

TheCAD Name of the document.t.

Supported API: true

See Also:

• EPMDocumentMaster
• Constant Field Values

OWNER_APPLICATION

public static final String 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

See Also:

• EPMDocumentMaster
• Constant Field Values

AUTHORING_APPLICATION

public static final String 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

See Also:

• EPMDocumentMaster
• Constant Field Values

DOC_TYPE

public static final String DOC_TYPE

Supported API: true

See Also:

• EPMDocumentMaster
• Constant Field Values

DOC_SUB_TYPE

public static final String DOC_SUB_TYPE

Supported API: true

See Also:

• EPMDocumentMaster
• Constant Field Values

DEFAULT_UNIT

public static final String DEFAULT_UNIT

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

Supported API: true

See Also:

• EPMDocumentMaster
• Constant Field Values

Method Details

getNumber

public String getNumber()

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:

• EPMDocumentMaster

setNumber

public void setNumber(String number)
               throws WTPropertyVetoException

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

Throws:

WTPropertyVetoException

See Also:

• EPMDocumentMaster

getName

public String getName()

The name of the document.

Supported API: true

Specified by:

getName in interface wt.projmgmt.deliverable.SubjectOfDeliverable

See Also:

• EPMDocumentMaster

setName

public void setName(String name)
             throws WTPropertyVetoException

The name of the document.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocumentMaster

getCADName

public String getCADName()

TheCAD Name of the document.t.

Supported API: true

See Also:

• EPMDocumentMaster

setCADName

public void setCADName(String CADName)
                throws WTPropertyVetoException

TheCAD Name of the document.t.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocumentMaster

getOwnerApplication

public EPMApplicationType getOwnerApplication()

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

See Also:

• EPMDocumentMaster

setOwnerApplication

public void setOwnerApplication(EPMApplicationType ownerApplication)
                         throws WTPropertyVetoException

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

Throws:

WTPropertyVetoException

See Also:

• EPMDocumentMaster

getAuthoringApplication

public EPMAuthoringAppType getAuthoringApplication()

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

See Also:

• EPMDocumentMaster

setAuthoringApplication

public void setAuthoringApplication(EPMAuthoringAppType authoringApplication)
                             throws WTPropertyVetoException

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

Throws:

WTPropertyVetoException

See Also:

• EPMDocumentMaster

getDocType

public EPMDocumentType getDocType()

Supported API: true

See Also:

• EPMDocumentMaster

setDocType

public void setDocType(EPMDocumentType docType)
                throws WTPropertyVetoException

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocumentMaster

getDocSubType

public EPMDocSubType getDocSubType()

Supported API: true

See Also:

• EPMDocumentMaster

setDocSubType

public void setDocSubType(EPMDocSubType docSubType)
                   throws WTPropertyVetoException

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocumentMaster

getDefaultUnit

public QuantityUnit getDefaultUnit()

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

Supported API: true

See Also:

• EPMDocumentMaster

setDefaultUnit

public void setDefaultUnit(QuantityUnit defaultUnit)
                    throws WTPropertyVetoException

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

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocumentMaster

getOrganizationReference

public WTPrincipalReference getOrganizationReference()

Supported API: true

Specified by:

getOrganizationReference in interface _OrganizationOwnedImpl

Specified by:

getOrganizationReference in interface OrganizationOwned

Returns:

WTPrincipalReference

See Also:

• OrganizationOwnedImpl

setOrganizationReference

public void setOrganizationReference(WTPrincipalReference organizationReference)
                              throws WTPropertyVetoException

Supported API: true

Specified by:

setOrganizationReference in interface _OrganizationOwnedImpl

Specified by:

setOrganizationReference in interface OrganizationOwned

Parameters:

organizationReference -

Throws:

WTPropertyVetoException

See Also:

• OrganizationOwnedImpl

getOrganizationUniqueIdentifier

public String getOrganizationUniqueIdentifier()

Supported API: true

Specified by:

getOrganizationUniqueIdentifier in interface _OrganizationOwned

See Also:

• OrganizationOwned

getOrganizationCodingSystem

public String getOrganizationCodingSystem()

Supported API: true

Specified by:

getOrganizationCodingSystem in interface _OrganizationOwned

See Also:

• OrganizationOwned

getOrganizationName

public String getOrganizationName()

Supported API: true

Specified by:

getOrganizationName in interface _OrganizationOwned

See Also:

• OrganizationOwned