Package wt.epm

Class EPMDocument

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.enterprise._RevisionControlled

wt.enterprise.RevisionControlled

wt.epm._EPMDocument

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

@GenAsPersistable(superClass=RevisionControlled.class,interfaces={EPMSupportingDataHolder.class,wt.doc.DocumentVersion.class,FormatContentHolder.class,Baselineable.class,EPMObject.class,BuildSource.class,wt.effectivity.EffectivityManageable.class,wt.viewmarkup.GraphicallyRepresentable.class,wt.ufid.Federatable.class,UsesOccurrenceContext.class,WTContained.class,OrganizationOwnedVersion.class,OneOffVersioned.class,wt.type.Typed.class,wt.epm.familytable.EPMFeatureContainer.class,wt.epm.familytable.EPMParameterContainer.class,wt.epm.interfaces.WorkspaceTrackable.class,Releasable.class,wt.fc.archive.Archiveable.class,wt.generic.OVTemplate.class,wt.generic.Variant.class,wt.access.IdentityAccessControlled.class,wt.fc.archive.ArchiveablePrimary.class,wt.build.VersionedBuildTarget.class,wt.enterprise.Templateable.class,wt.sandbox.Interoperable.class,PersistedCollectable.class,ModelItemContainer.class,AlternateRepContainer.class,wt.folder.history.Movable.class,Genericizable.class,wt.projmgmt.deliverable.VersionedSubjectOfDeliverable.class},versions={-3631708184502426123L,2481771402836305255L},properties={@GeneratedProperty(name="extentsValid",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="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."),@GeneratedProperty(name="missingDependents",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="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.",constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="placeHolder",type=boolean.class,initialValue="false",supportedAPI=PUBLIC,javaDoc="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.",constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="description",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="A user-specified description field.",constraints=@PropertyConstraints(upperLimit=2000)),@GeneratedProperty(name="dbKeySize",type=int.class),@GeneratedProperty(name="verified",type=boolean.class,initialValue="true"),@GeneratedProperty(name="revisionNumber",type=int.class),@GeneratedProperty(name="familyTableStatus",type=int.class,supportedAPI=PUBLIC),@GeneratedProperty(name="lengthScale",type=java.lang.Double.class,supportedAPI=PUBLIC),@GeneratedProperty(name="derived",type=boolean.class,initialValue="false",javaDoc="Document is derived representation or original."),@GeneratedProperty(name="boxExtents",type=EPMBoxExtents.class,supportedAPI=PUBLIC,accessors=@PropertyAccessors(setExceptions={}),columnProperties=@ColumnProperties(columnName="D")),@GeneratedProperty(name="referenceControl",type=wt.epm.EPMCADReferenceControl.class,columnProperties=@ColumnProperties(columnName="E"))},foreignKeys={@GeneratedForeignKey(foreignKeyRole=@ForeignKeyRole(name="master",type=EPMDocumentMaster.class,supportedAPI=PUBLIC,cascade=false,constraints=@PropertyConstraints(required=true),accessors=@PropertyAccessors(getAccess=PRIVATE)),myRole=@MyRole(name="iteration",supportedAPI=PUBLIC,cascade=false,accessors=@PropertyAccessors(getAccess=PRIVATE,setAccess=PROTECTED))),@GeneratedForeignKey(name="AuthoringAppVersionLink",foreignKeyRole=@ForeignKeyRole(name="authoringAppVersion",type=EPMAuthoringAppVersion.class,referenceType=EPMAuthAppVersionRef.class,owner=false),myRole=@MyRole(name="doc")),@GeneratedForeignKey(foreignKeyRole=@ForeignKeyRole(name="asStoredConfig",type=EPMAsStoredConfig.class,javaDoc="The reference to asStoredConfig object which this EPMDocument object owns."),myRole=@MyRole(name="document",cardinality=ONE_TO_MANY))},derivedProperties={@DerivedProperty(name="number",derivedFrom="master>number",supportedAPI=PUBLIC),@DerivedProperty(name="name",derivedFrom="master>name",supportedAPI=PUBLIC),@DerivedProperty(name="CADName",derivedFrom="master>CADName",supportedAPI=PUBLIC),@DerivedProperty(name="globalID",derivedFrom="master>globalID",supportedAPI=PRIVATE,accessors=@PropertyAccessors(setAccess=PRIVATE)),@DerivedProperty(name="docType",derivedFrom="master>docType",supportedAPI=PUBLIC),@DerivedProperty(name="docSubType",derivedFrom="master>docSubType",supportedAPI=PUBLIC),@DerivedProperty(name="ownerApplication",derivedFrom="master>ownerApplication",supportedAPI=PUBLIC,accessors=@PropertyAccessors(setAccess=PRIVATE)),@DerivedProperty(name="authoringApplication",derivedFrom="master>authoringApplication",supportedAPI=PUBLIC,accessors=@PropertyAccessors(setAccess=PRIVATE)),@DerivedProperty(name="defaultUnit",derivedFrom="master>defaultUnit",supportedAPI=PUBLIC,accessors=@PropertyAccessors(setAccess=PRIVATE))},tableProperties=@TableProperties(compositeIndex10="+ownership.owner.key.id+checkoutInfo.state",compositeIndex11="thePersistInfo.theObjectIdentifier.id+masterReference.key.id",compositeIndex12="asStoredConfigReference.key.id",compositeIndex13="masterReference.key.id+versionInfo.identifier.versionSortId",compositeUnique1="+oneOffVersionInfo.identifier.oneOffVersionId"),iconProperties=@IconProperties(standardIcon="wt/clients/images/epmdoc.gif",openIcon="wt/clients/images/epmdoc.gif"))
public class EPMDocument
extends _EPMDocument

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

Fields inherited from class wt.epm._EPMDocument

AUTHORING_APPLICATION, BOX_EXTENTS, CADNAME, DEFAULT_UNIT, DESCRIPTION, DOC_SUB_TYPE, DOC_TYPE, EXTENTS_VALID, FAMILY_TABLE_STATUS, LENGTH_SCALE, MISSING_DEPENDENTS, NAME, NUMBER, OWNER_APPLICATION, PLACE_HOLDER

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()	Gets the value of the attribute: AUTHORING_APPLICATION.
String	getCADName()	Gets the value of the attribute: CADNAME.
QuantityUnit	getDefaultUnit()	Gets the value of the attribute: DEFAULT_UNIT.
EPMDocSubType	getDocSubType()	Gets the value of the attribute: DOC_SUB_TYPE.
EPMDocumentType	getDocType()	Gets the value of the attribute: 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	getOrganizationUniqueIdentifier()	Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER.
EPMApplicationType	getOwnerApplication()	Gets the value of the attribute: OWNER_APPLICATION.
protected void	initialize(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName)	Supports initialization, following construction of an instance.
protected void	initialize(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName, String globalID)	Supports initialization, following construction of an instance.
protected void	initialize(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName, QuantityUnit defaultUnit)	Supports initialization, following construction of an instance.
protected void	initialize(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName, QuantityUnit defaultUnit, String globalID)	Supports initialization, following construction of an instance.
boolean	isGeneric()	Gets the value of the attribute: GENERIC.
boolean	isInstance()	Gets the value of the attribute: INSTANCE.
boolean	isTopGeneric()	Gets the value of the attribute: TOP_GENERIC.
static EPMDocument	newEPMDocument()	For internal use.
static EPMDocument	newEPMDocument(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName)	Please note that use of this constructor can be very risky.
static EPMDocument	newEPMDocument(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName, String globalID)	Please note that use of this constructor can be very risky.
static EPMDocument	newEPMDocument(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName, QuantityUnit defaultUnit)	Please note that use of this constructor can be very risky.
static EPMDocument	newEPMDocument(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName, QuantityUnit defaultUnit, String globalID)	Please note that use of this constructor can be very risky.
void	setCADName(String a_CADName)	Sets the value of the attribute: CADNAME.
void	setDescription(String a_Description)	Sets the value of the attribute: DESCRIPTION.
void	setDocSubType(EPMDocSubType a_DocSubType)	Sets the value of the attribute: DOC_SUB_TYPE.
void	setDocType(EPMDocumentType a_DocType)	Sets the value of the attribute: DOC_TYPE.
void	setGeneric(boolean a_Generic)	Sets the value of the attribute: GENERIC.
void	setInstance(boolean a_Instance)	Sets the value of the attribute: INSTANCE.
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	setPlaceHolder(boolean a_PlaceHolder)	Sets the value of the attribute: PLACE_HOLDER.
void	setTopGeneric(boolean a_TopGeneric)	Sets the value of the attribute: TOP_GENERIC.

Methods inherited from class wt.epm._EPMDocument

getBoxExtents, getDescription, getFamilyTableStatus, getGenericType, getLengthScale, getOrganizationCodingSystem, getOrganizationName, isExtentsValid, isMissingDependents, isPlaceHolder, setBoxExtents, setExtentsValid, setFamilyTableStatus, setGenericType, setLengthScale, setMissingDependents

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

Method Details

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 EPMDocument, it is actually implemented on the master.

Supported API: true

Overrides:

getNumber in class _EPMDocument

Returns:

String

See Also:

• EPMDocument

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 EPMDocument, it is actually implemented on the master.

Supported API: true

Overrides:

setNumber in class _EPMDocument

Parameters:

a_Number -

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

getName

public String getName()

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

Supported API: true

Specified by:

getName in interface CabinetBased

Specified by:

getName in interface wt.projmgmt.deliverable.SubjectOfDeliverable

Overrides:

getName in class _EPMDocument

Returns:

String

See Also:

• EPMDocument

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

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

Supported API: true

Overrides:

setName in class _EPMDocument

Parameters:

a_Name -

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

getCADName

public String getCADName()

Gets the value of the attribute: CADNAME. The CAD name of the document.

Supported API: true

Overrides:

getCADName in class _EPMDocument

Returns:

String

See Also:

• EPMDocument

setCADName

public void setCADName(String a_CADName)
                throws WTPropertyVetoException

Sets the value of the attribute: CADNAME. The CAD name of the document.

Supported API: true

Overrides:

setCADName in class _EPMDocument

Parameters:

a_CADName -

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

getDocType

public EPMDocumentType getDocType()

Gets the value of the attribute: DOC_TYPE. The type of the document

Supported API: true

Overrides:

getDocType in class _EPMDocument

Returns:

EPMDocumentType

See Also:

• EPMDocument

setDocType

public void setDocType(EPMDocumentType a_DocType)
                throws WTPropertyVetoException

Sets the value of the attribute: DOC_TYPE. The type of the document

Supported API: true

Overrides:

setDocType in class _EPMDocument

Parameters:

a_DocType -

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

getDocSubType

public EPMDocSubType getDocSubType()

Gets the value of the attribute: DOC_SUB_TYPE. The subtype of the document

Supported API: true

Overrides:

getDocSubType in class _EPMDocument

Returns:

EPMDocSubType

See Also:

• EPMDocument

setDocSubType

public void setDocSubType(EPMDocSubType a_DocSubType)
                   throws WTPropertyVetoException

Sets the value of the attribute: DOC_SUB_TYPE. The subtype of the document

Supported API: true

Overrides:

setDocSubType in class _EPMDocument

Parameters:

a_DocSubType -

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

setPlaceHolder

public void setPlaceHolder(boolean a_PlaceHolder)
                    throws WTPropertyVetoException

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

Overrides:

setPlaceHolder in class _EPMDocument

Parameters:

a_PlaceHolder -

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. A user-specified description field.

Supported API: true

Overrides:

setDescription in class _EPMDocument

Parameters:

a_Description -

Throws:

WTPropertyVetoException

See Also:

• EPMDocument

getOwnerApplication

public EPMApplicationType getOwnerApplication()

Gets the value of the attribute: OWNER_APPLICATION. Indicate that the named application owns the object. This attribute is derived from EPMDocumentMaster.

The parameter is an EPMApplicationType, so that any sort of checking can be done at run-time.

Although EPMObject has the same derived attribute, defining it in EPMDocument makes querying EPMDocument on ownerApplication possible.

Supported API: true

Specified by:

getOwnerApplication in interface EPMObject

Overrides:

getOwnerApplication in class _EPMDocument

Returns:

EPMApplicationType

See Also:

• EPMDocument

getAuthoringApplication

public EPMAuthoringAppType getAuthoringApplication()

Gets the value of the attribute: AUTHORING_APPLICATION. Indicates that the named application authored the object. This attribute is derived from EPMDocumentMaster.

The parameter is an EPMAuthoringAppType, so that any sort of checking can be done at run-time.

Although EPMObject has the same derived attribute, defining it on EPMDocument makes querying EPMDocument on authoringApplication possible.

Supported API: true

Specified by:

getAuthoringApplication in interface EPMObject

Overrides:

getAuthoringApplication in class _EPMDocument

Returns:

EPMAuthoringAppType

See Also:

• EPMDocument

isGeneric

public boolean isGeneric()

Gets the value of the attribute: GENERIC. True if EPMDocument is family table generic.

Supported API: true

Returns:

boolean

setGeneric

public void setGeneric(boolean a_Generic)
                throws WTPropertyVetoException

Sets the value of the attribute: GENERIC. True if EPMDocument is family table generic.

Supported API: true

Parameters:

a_Generic -

Throws:

WTPropertyVetoException

isInstance

public boolean isInstance()

Gets the value of the attribute: INSTANCE. True if EPMDocument is family table instance.

Supported API: true

Returns:

boolean

setInstance

public void setInstance(boolean a_Instance)
                 throws WTPropertyVetoException

Sets the value of the attribute: INSTANCE. True if EPMDocument is family table instance.

Supported API: true

Parameters:

a_Instance -

Throws:

WTPropertyVetoException

isTopGeneric

public boolean isTopGeneric()

Gets the value of the attribute: TOP_GENERIC. True if EPMDocument is family table top generic.

Supported API: true

Returns:

boolean

setTopGeneric

public void setTopGeneric(boolean a_TopGeneric)
                   throws WTPropertyVetoException

Sets the value of the attribute: TOP_GENERIC. True if EPMDocument is family table top generic.

Supported API: true

Parameters:

a_TopGeneric -

Throws:

WTPropertyVetoException

getDefaultUnit

public QuantityUnit getDefaultUnit()

Gets the value of the attribute: DEFAULT_UNIT. The default unit of measure for the document.

Supported API: true

Overrides:

getDefaultUnit in class _EPMDocument

Returns:

QuantityUnit

See Also:

• EPMDocument

newEPMDocument

public static EPMDocument newEPMDocument()
                                  throws WTException

For internal use. Do Not Use. Please note that use of this constructor can be very risky. Please do not create EPMDocuments in this manner unless you know exactly what data is required by the application, as incorrect usage can result in data corruptions.

Supported API: true

Returns:

EPMDocument

Throws:

WTException

newEPMDocument

public static EPMDocument newEPMDocument(String number,
 String name,
 EPMAuthoringAppType authoringApp,
 EPMDocumentType docType,
 String CADName)
                                  throws WTException

Please note that use of this constructor can be very risky. Please do not create EPMDocuments in this manner unless you know exactly what data is required by the application, as incorrect usage can result in data corruptions.

Supported API: true

Parameters:

number - Number is optional parameter. If Number is null, Auto-Number generator will set it.

name - Name is optional parameter. Null is allowed.

authoringApp -

docType -

CADName -

Returns:

EPMDocument

Throws:

WTException

newEPMDocument

public static EPMDocument newEPMDocument(String number,
 String name,
 EPMAuthoringAppType authoringApp,
 EPMDocumentType docType,
 String CADName,
 String globalID)
                                  throws WTException

Please note that use of this constructor can be very risky. Please do not create EPMDocuments in this manner unless you know exactly what data is required by the application, as incorrect usage can result in data corruptions.

Supported API: true

Parameters:

number - Number is optional parameter. If Number is null, Auto-Number generator will set it.

name - Name is optional parameter. Null is allowed.

authoringApp -

docType -

CADName -

globalID -

Returns:

EPMDocument

Throws:

WTException

initialize

protected void initialize(String number,
 String name,
 EPMAuthoringAppType authoringApp,
 EPMDocumentType docType,
 String CADName)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

number - Number is optional parameter. If Number is null, Auto-Number generator will set it.

name - Name is optional parameter. Null is allowed.

authoringApp -

docType -

CADName -

Throws:

WTException

initialize

protected void initialize(String number,
 String name,
 EPMAuthoringAppType authoringApp,
 EPMDocumentType docType,
 String CADName,
 String globalID)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

number - Number is optional parameter. If Number is null, Auto-Number generator will set it.

name - Name is optional parameter. Null is allowed.

authoringApp -

docType -

CADName -

globalID -

Throws:

WTException

newEPMDocument

public static EPMDocument newEPMDocument(String number,
 String name,
 EPMAuthoringAppType authoringApp,
 EPMDocumentType docType,
 String CADName,
 QuantityUnit defaultUnit,
 String globalID)
                                  throws WTException

Please note that use of this constructor can be very risky. Please do not create EPMDocuments in this manner unless you know exactly what data is required by the application, as incorrect usage can result in data corruptions.

Supported API: true

Parameters:

number - Number is optional parameter. If Number is null, Auto-Number generator will set it.

name - Name is optional parameter. Null is allowed.

authoringApp -

docType -

CADName -

defaultUnit -

globalID -

Returns:

EPMDocument

Throws:

WTException

initialize

protected void initialize(String number,
 String name,
 EPMAuthoringAppType authoringApp,
 EPMDocumentType docType,
 String CADName,
 QuantityUnit defaultUnit,
 String globalID)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

number - Number is optional parameter. If Number is null, Auto-Number generator will set it.

name - Name is optional parameter. Null is allowed.

authoringApp -

docType -

CADName -

defaultUnit -

globalID -

Throws:

WTException

newEPMDocument

public static EPMDocument newEPMDocument(String number,
 String name,
 EPMAuthoringAppType authoringApp,
 EPMDocumentType docType,
 String CADName,
 QuantityUnit defaultUnit)
                                  throws WTException

Please note that use of this constructor can be very risky. Please do not create EPMDocuments in this manner unless you know exactly what data is required by the application, as incorrect usage can result in data corruptions.

Supported API: true

Parameters:

number - Number is optional parameter. If Number is null, Auto-Number generator will set it.

name - Name is optional parameter. Null is allowed.

authoringApp -

docType -

CADName -

defaultUnit -

Returns:

EPMDocument

Throws:

WTException

initialize

protected void initialize(String number,
 String name,
 EPMAuthoringAppType authoringApp,
 EPMDocumentType docType,
 String CADName,
 QuantityUnit defaultUnit)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: true

Parameters:

number - Number is optional parameter. If Number is null, Auto-Number generator will set it.

name - Name is optional parameter. Null is allowed.

authoringApp -

docType -

CADName -

defaultUnit -

Throws:

WTException

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

Overrides:

getOrganizationUniqueIdentifier in class _EPMDocument

Returns:

String

See Also:

• OrganizationOwned

getOrganization

public WTOrganization getOrganization()

Gets the value of the attribute: ORGANIZATION.

Supported API: true

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