Package wt.epm

Class _EPMDocument

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.enterprise._RevisionControlled

wt.enterprise.RevisionControlled

wt.epm._EPMDocument

All Implemented Interfaces:

com.ptc.windchill.bac._BACManaged, com.ptc.windchill.bac.BACManaged, Externalizable, Serializable, wt.access._AccessControlled, wt.access._AccessControlList, wt.access._AdHocControlled, wt.access._IdentityAccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.AccessControlList, AdHocControlled, wt.access.IdentityAccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.build._BuildSource, wt.build._BuildTarget, wt.build._VersionedBuildTarget, BuildSource, BuildTarget, wt.build.VersionedBuildTarget, wt.change2._Changeable2, wt.change2._ChangeableIfc, Changeable2, ChangeableIfc, wt.content._ContentHolder, wt.content._FormatContentHolder, ContentHolder, FormatContentHolder, wt.doc._Document, wt.doc._DocumentVersion, Document, wt.doc.DocumentVersion, wt.eff._EffManagedVersion, wt.eff._EffRecordable, EffManagedVersion, EffRecordable, wt.effectivity._EffectivityHolder, wt.effectivity._EffectivityManageable, EffectivityHolder, wt.effectivity.EffectivityManageable, wt.enterprise._Templateable, wt.enterprise.Templateable, wt.epm._EPMObject, wt.epm.alternaterep._AlternateRepContainer, AlternateRepContainer, EPMObject, wt.epm.familytable._EPMFeatureContainer, wt.epm.familytable._EPMParameterContainer, wt.epm.familytable.EPMFeatureContainer, wt.epm.familytable.EPMParameterContainer, wt.epm.interfaces._Trackable, wt.epm.interfaces._WorkspaceTrackable, wt.epm.interfaces.Trackable, wt.epm.interfaces.WorkspaceTrackable, wt.epm.modelitems._ModelItemContainer, ModelItemContainer, wt.epm.supportingdata._EPMSupportingDataHolder, EPMSupportingDataHolder, wt.esi._Releasable, Releasable, wt.facade.persistedcollection._PersistedCollectable, PersistedCollectable, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, wt.fc.archive._Archiveable, wt.fc.archive._ArchiveablePrimary, wt.fc.archive.Archiveable, wt.fc.archive.ArchiveablePrimary, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, wt.federation._FederatedLinkHolder, wt.federation._RemotelyLinkable, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, wt.folder._CabinetBased, wt.folder._Foldered, wt.folder._FolderEntry, wt.folder._FolderServiceManaged, wt.folder._IteratedFoldered, CabinetBased, Foldered, FolderEntry, wt.folder.FolderServiceManaged, wt.folder.history.Movable, IteratedFoldered, _Genericizable, wt.generic._OVTemplate, wt.generic._Variant, Genericizable, wt.generic.OVTemplate, wt.generic.Variant, wt.iba.value._IBAHolder, wt.iba.value.IBAHolder, DisplayIdentification, wt.index._Indexable, Indexable, wt.inf.container._WTContained, wt.inf.container._WTContainedFilterable, WTContained, wt.inf.container.WTContainedFilterable, wt.lifecycle._IteratedLifeCycleManaged, _LifeCycleManaged, IteratedLifeCycleManaged, LifeCycleManaged, wt.locks._Lockable, Lockable, wt.maturity._Promotable, Promotable, wt.meeting.actionitem._IteratedSubjectOfActionItem, wt.meeting.actionitem._SubjectOfActionItem, wt.meeting.actionitem.IteratedSubjectOfActionItem, wt.meeting.actionitem.SubjectOfActionItem, wt.notify._Notifiable, Notifiable, wt.occurrence._UsesOccurrenceContext, UsesOccurrenceContext, wt.option._ChoiceMappable, wt.option._Expressionable, wt.option._ExpressionAssignable, ChoiceMappable, Expressionable, ExpressionAssignable, _OrganizationOwned, wt.org._OrganizationOwnedVersion, wt.org.electronicIdentity._ElectronicallySignable, wt.org.electronicIdentity.ElectronicallySignable, OrganizationOwned, OrganizationOwnedVersion, wt.ownership._Ownable, wt.ownership.Ownable, wt.projmgmt.deliverable._SubjectOfDeliverable, wt.projmgmt.deliverable._VersionedSubjectOfDeliverable, wt.projmgmt.deliverable.SubjectOfDeliverable, wt.projmgmt.deliverable.VersionedSubjectOfDeliverable, wt.recent.RecentlyVisited, wt.representation._Representable, wt.representation._RepresentablesAndMasters, wt.representation._RepresentationContributor, Representable, wt.representation.RepresentablesAndMasters, wt.representation.RepresentationContributor, wt.sandbox._Interoperable, wt.sandbox.Interoperable, _TeamManaged, TeamManaged, wt.type._Typed, wt.type._TypeManaged, wt.type.FlexTyped, wt.type.Typed, wt.type.TypeManaged, wt.ufid._Federatable, wt.ufid.Federatable, _Iterated, wt.vc._OneOffVersioned, wt.vc._Versionable, wt.vc._Versioned, wt.vc.baseline._Baselineable, Baselineable, Iterated, OneOffVersioned, Versionable, Versioned, wt.vc.wip._Workable, Workable, wt.viewmarkup._GraphicallyRepresentable, wt.viewmarkup._Viewable, wt.viewmarkup.GraphicallyRepresentable, wt.viewmarkup.Viewable, wt.workflow.forum._IteratedSubjectOfForum, wt.workflow.forum._SubjectOfForum, wt.workflow.forum.IteratedSubjectOfForum, SubjectOfForum, wt.workflow.notebook._IteratedSubjectOfNotebook, wt.workflow.notebook._SubjectOfNotebook, wt.workflow.notebook.IteratedSubjectOfNotebook, wt.workflow.notebook.SubjectOfNotebook

Direct Known Subclasses:

EPMDocument

public abstract class _EPMDocument
extends RevisionControlled
implements EPMSupportingDataHolder, wt.doc.DocumentVersion, FormatContentHolder, Baselineable, EPMObject, BuildSource, wt.effectivity.EffectivityManageable, wt.viewmarkup.GraphicallyRepresentable, wt.ufid.Federatable, UsesOccurrenceContext, WTContained, OrganizationOwnedVersion, OneOffVersioned, wt.type.Typed, wt.epm.familytable.EPMFeatureContainer, wt.epm.familytable.EPMParameterContainer, wt.epm.interfaces.WorkspaceTrackable, Releasable, wt.fc.archive.Archiveable, wt.generic.OVTemplate, wt.generic.Variant, wt.access.IdentityAccessControlled, wt.fc.archive.ArchiveablePrimary, wt.build.VersionedBuildTarget, wt.enterprise.Templateable, wt.sandbox.Interoperable, PersistedCollectable, ModelItemContainer, AlternateRepContainer, wt.folder.history.Movable, Genericizable, wt.projmgmt.deliverable.VersionedSubjectOfDeliverable, Externalizable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHORING_APPLICATION	Supported API: true
static final String	BOX_EXTENTS	Supported API: true
static final String	CADNAME	Supported API: true
static final String	DEFAULT_UNIT	Supported API: true
static final String	DESCRIPTION	A user-specified description field.
static final String	DOC_SUB_TYPE	Supported API: true
static final String	DOC_TYPE	Supported API: true
static final String	EXTENTS_VALID	Indicator of the validity of the current EPMBoxExtents.
static final String	FAMILY_TABLE_STATUS	Supported API: true
static final String	LENGTH_SCALE	Supported API: true
static final String	MISSING_DEPENDENTS	Flag to indicate if some of the dependencies of the CADModel are missing.
static final String	NAME	Supported API: true
static final String	NUMBER	Supported API: true
static final String	OWNER_APPLICATION	Supported API: true
static final String	PLACE_HOLDER	Indicates if the newly created CAD Document is a placeholder.

Fields inherited from interface wt.generic._Genericizable

GENERIC_TYPE

Fields inherited from interface wt.vc._Iterated

CONTROL_BRANCH, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_NOTE, LATEST_ITERATION, MASTER, MASTER_REFERENCE, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Fields inherited from interface wt.lifecycle._LifeCycleManaged

LIFE_CYCLE_STATE, STATE

Fields inherited from interface wt.org._OrganizationOwned

ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Fields inherited from interface wt.team._TeamManaged

TEAM_ID, TEAM_TEMPLATE_ID

Method Summary

Modifier and Type	Method	Description
EPMAuthoringAppType	getAuthoringApplication()	Derived from _EPMDocumentMaster.getAuthoringApplication()
EPMBoxExtents	getBoxExtents()	Supported API: true
String	getCADName()	Derived from _EPMDocumentMaster.getCADName()
QuantityUnit	getDefaultUnit()	Derived from _EPMDocumentMaster.getDefaultUnit()
String	getDescription()	A user-specified description field.
EPMDocSubType	getDocSubType()	Derived from _EPMDocumentMaster.getDocSubType()
EPMDocumentType	getDocType()	Derived from _EPMDocumentMaster.getDocType()
int	getFamilyTableStatus()	Supported API: true
GenericType	getGenericType()	Derived from _EPMDocumentMaster.getGenericType()
Double	getLengthScale()	Supported API: true
String	getName()	Derived from _EPMDocumentMaster.getName()
String	getNumber()	Derived from _EPMDocumentMaster.getNumber()
String	getOrganizationCodingSystem()	Supported API: true
String	getOrganizationName()	Supported API: true
String	getOrganizationUniqueIdentifier()	Supported API: true
EPMApplicationType	getOwnerApplication()	Derived from _EPMDocumentMaster.getOwnerApplication()
boolean	isExtentsValid()	Indicator of the validity of the current EPMBoxExtents.
boolean	isMissingDependents()	Flag to indicate if some of the dependencies of the CADModel are missing.
boolean	isPlaceHolder()	Indicates if the newly created CAD Document is a placeholder.
void	setBoxExtents(EPMBoxExtents boxExtents)	Supported API: true
void	setCADName(String CADName)	Derived from EPMDocumentMaster.setCADName(java.lang.String)
void	setDescription(String description)	A user-specified description field.
void	setDocSubType(EPMDocSubType docSubType)	Derived from EPMDocumentMaster.setDocSubType(wt.epm.EPMDocSubType)
void	setDocType(EPMDocumentType docType)	Derived from EPMDocumentMaster.setDocType(wt.epm.EPMDocumentType)
void	setExtentsValid(boolean extentsValid)	Indicator of the validity of the current EPMBoxExtents.
void	setFamilyTableStatus(int familyTableStatus)	Supported API: true
void	setGenericType(GenericType genericType)	Derived from _EPMDocumentMaster.setGenericType(wt.generic.GenericType)
void	setLengthScale(Double lengthScale)	Supported API: true
void	setMissingDependents(boolean missingDependents)	Flag to indicate if some of the dependencies of the CADModel are missing.
void	setName(String name)	Derived from EPMDocumentMaster.setName(java.lang.String)
void	setNumber(String number)	Derived from EPMDocumentMaster.setNumber(java.lang.String)
void	setPlaceHolder(boolean placeHolder)	Indicates if the newly created CAD Document is a placeholder.

Methods inherited from class wt.enterprise._RevisionControlled

getControlBranch, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationNote, getLifeCycleState, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, getState, getTeamId, getTeamTemplateId, isLatestIteration, setMaster, setMasterReference

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.vc._Iterated

getControlBranch, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationNote, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, isLatestIteration, setMaster, setMasterReference

Methods inherited from interface wt.epm.EPMObject

checkAttributes

Methods inherited from interface wt.org.OrganizationOwned

getOrganization

Methods inherited from interface wt.fc.Persistable

checkAttributes

Field Details

EXTENTS_VALID

public static final String EXTENTS_VALID

Indicator of the validity of the current EPMBoxExtents. This value will allow the user to postpone recalculation of the extents after a modification of the CAD model.

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

MISSING_DEPENDENTS

public static final String MISSING_DEPENDENTS

Flag to indicate if some of the dependencies of the CADModel are missing. Those missing dependents are either ignored or not available when the data is published.

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

PLACE_HOLDER

public static final String PLACE_HOLDER

Indicates if the newly created CAD Document is a placeholder. It will become a fully defined document when client gets the real CAD model. User may not publish the document until it is resolved. Till then it will remain in users personal folder.

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

A user-specified description field.

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

FAMILY_TABLE_STATUS

public static final String FAMILY_TABLE_STATUS

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

LENGTH_SCALE

public static final String LENGTH_SCALE

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

BOX_EXTENTS

public static final String BOX_EXTENTS

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

NUMBER

public static final String NUMBER

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

NAME

public static final String NAME

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

CADNAME

public static final String CADNAME

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

DOC_TYPE

public static final String DOC_TYPE

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

DOC_SUB_TYPE

public static final String DOC_SUB_TYPE

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

OWNER_APPLICATION

public static final String OWNER_APPLICATION

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

AUTHORING_APPLICATION

public static final String AUTHORING_APPLICATION

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

DEFAULT_UNIT

public static final String DEFAULT_UNIT

Supported API: true

See Also:

• EPMDocument
• Constant Field Values

Method Details

isExtentsValid

public boolean isExtentsValid()

Indicator of the validity of the current EPMBoxExtents. This value will allow the user to postpone recalculation of the extents after a modification of the CAD model.

Supported API: true

See Also:

• EPMDocument

setExtentsValid

public void setExtentsValid(boolean extentsValid)
                     throws WTPropertyVetoException

Indicator of the validity of the current EPMBoxExtents. This value will allow the user to postpone recalculation of the extents after a modification of the CAD model.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

isMissingDependents

public boolean isMissingDependents()

Flag to indicate if some of the dependencies of the CADModel are missing. Those missing dependents are either ignored or not available when the data is published.

Supported API: true

See Also:

• EPMDocument

setMissingDependents

public void setMissingDependents(boolean missingDependents)
                          throws WTPropertyVetoException

Flag to indicate if some of the dependencies of the CADModel are missing. Those missing dependents are either ignored or not available when the data is published.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

isPlaceHolder

public boolean isPlaceHolder()

Indicates if the newly created CAD Document is a placeholder. It will become a fully defined document when client gets the real CAD model. User may not publish the document until it is resolved. Till then it will remain in users personal folder.

Supported API: true

See Also:

• EPMDocument

setPlaceHolder

public void setPlaceHolder(boolean placeHolder)
                    throws WTPropertyVetoException

Indicates if the newly created CAD Document is a placeholder. It will become a fully defined document when client gets the real CAD model. User may not publish the document until it is resolved. Till then it will remain in users personal folder.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

getDescription

public String getDescription()

A user-specified description field.

Supported API: true

See Also:

• EPMDocument

setDescription

public void setDescription(String description)
                    throws WTPropertyVetoException

A user-specified description field.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

getFamilyTableStatus

public int getFamilyTableStatus()

Supported API: true

See Also:

• EPMDocument

setFamilyTableStatus

public void setFamilyTableStatus(int familyTableStatus)
                          throws WTPropertyVetoException

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

getLengthScale

public Double getLengthScale()

Supported API: true

See Also:

• EPMDocument

setLengthScale

public void setLengthScale(Double lengthScale)
                    throws WTPropertyVetoException

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

getBoxExtents

public EPMBoxExtents getBoxExtents()

Supported API: true

See Also:

• EPMDocument

setBoxExtents

public void setBoxExtents(EPMBoxExtents boxExtents)

Supported API: true

See Also:

• EPMDocument

getNumber

public String getNumber()

Derived from _EPMDocumentMaster.getNumber()

Supported API: true

See Also:

• EPMDocument

setNumber

public void setNumber(String number)
               throws WTPropertyVetoException

Derived from EPMDocumentMaster.setNumber(java.lang.String)

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

getName

public String getName()

Derived from _EPMDocumentMaster.getName()

Supported API: true

Specified by:

getName in interface CabinetBased

Specified by:

getName in interface wt.projmgmt.deliverable.SubjectOfDeliverable

Overrides:

getName in class RevisionControlled

Returns:

String

See Also:

• EPMDocument

setName

public void setName(String name)
             throws WTPropertyVetoException

Derived from EPMDocumentMaster.setName(java.lang.String)

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

getCADName

public String getCADName()

Derived from _EPMDocumentMaster.getCADName()

Supported API: true

See Also:

• EPMDocument

setCADName

public void setCADName(String CADName)
                throws WTPropertyVetoException

Derived from EPMDocumentMaster.setCADName(java.lang.String)

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

getDocType

public EPMDocumentType getDocType()

Derived from _EPMDocumentMaster.getDocType()

Supported API: true

See Also:

• EPMDocument

setDocType

public void setDocType(EPMDocumentType docType)
                throws WTPropertyVetoException

Derived from EPMDocumentMaster.setDocType(wt.epm.EPMDocumentType)

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

getDocSubType

public EPMDocSubType getDocSubType()

Derived from _EPMDocumentMaster.getDocSubType()

Supported API: true

See Also:

• EPMDocument

setDocSubType

public void setDocSubType(EPMDocSubType docSubType)
                   throws WTPropertyVetoException

Derived from EPMDocumentMaster.setDocSubType(wt.epm.EPMDocSubType)

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

getOwnerApplication

public EPMApplicationType getOwnerApplication()

Derived from _EPMDocumentMaster.getOwnerApplication()

Supported API: true

Specified by:

getOwnerApplication in interface EPMObject

Returns:

EPMApplicationType

See Also:

• EPMDocument

getAuthoringApplication

public EPMAuthoringAppType getAuthoringApplication()

Derived from _EPMDocumentMaster.getAuthoringApplication()

Supported API: true

Specified by:

getAuthoringApplication in interface EPMObject

Returns:

EPMAuthoringAppType

See Also:

• EPMDocument

getDefaultUnit

public QuantityUnit getDefaultUnit()

Derived from _EPMDocumentMaster.getDefaultUnit()

Supported API: true

See Also:

• EPMDocument

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

getGenericType

public GenericType getGenericType()

Derived from _EPMDocumentMaster.getGenericType()

Supported API: true

Specified by:

getGenericType in interface _Genericizable

See Also:

• Genericizable

setGenericType

public void setGenericType(GenericType genericType)
                    throws WTPropertyVetoException

Derived from _EPMDocumentMaster.setGenericType(wt.generic.GenericType)

Supported API: true

Specified by:

setGenericType in interface _Genericizable

Throws:

WTPropertyVetoException

See Also:

• Genericizable