Class 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
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:
-
Field Summary
Fields inherited from class wt.epm._EPMDocument
AS_STORED_CONFIG, AS_STORED_CONFIG_REFERENCE, AUTHORING_APP_VERSION, AUTHORING_APP_VERSION_REFERENCE, AUTHORING_APPLICATION, BOX_EXTENTS, CADNAME, DB_KEY_SIZE, DEFAULT_UNIT, DERIVED, DESCRIPTION, DOC_SUB_TYPE, DOC_TYPE, EXTENTS_VALID, EXTERNALIZATION_VERSION_UID, FAMILY_TABLE_STATUS, GLOBAL_ID, LENGTH_SCALE, MISSING_DEPENDENTS, NAME, NUMBER, OWNER_APPLICATION, PLACE_HOLDER, REFERENCE_CONTROL, REVISION_NUMBER, VERIFIEDFields inherited from class wt.enterprise.RevisionControlled
VERSION_DISPLAY_IDENTIFIER, VERSION_DISPLAY_IDENTITY, VERSION_DISPLAY_TYPEFields inherited from class wt.fc._WTObject
CREATE_TIMESTAMP, MODIFY_TIMESTAMPFields inherited from interface wt.access._AdHocControlled
ENTRY_SETFields inherited from interface wt.fc.adminlock._AdministrativelyLockable
ADMINISTRATIVE_LOCKFields inherited from interface wt.change2._Changeable2
HAS_HANGING_CHANGE, HAS_PENDING_CHANGE, HAS_RESULTING_CHANGE, HAS_SUSPECT, HAS_VARIANCEFields inherited from interface wt.content._ContentHolder
CONTENT_VECTOR, HAS_CONTENTS, HTTP_VECTOR, OPERATIONFields inherited from interface wt.admin._DomainAdministered
DOMAIN_REF, INHERITED_DOMAINFields inherited from interface wt.eff._EffRecordable
EFF_VECTORFields inherited from interface wt.option._Expressionable
EXPRESSION_DATAFields inherited from interface wt.ufid._Federatable
FEDERATABLE_INFOFields inherited from interface wt.folder._Foldered
CABINET, CABINET_NAME, FOLDERING_INFO, PARENT_FOLDERFields inherited from interface wt.content._FormatContentHolder
FORMAT, FORMAT_NAME, PRIMARYFields inherited from interface wt.generic._Genericizable
COLLAPSIBLE, GENERIC_TYPE, MAXIMUM_ALLOWED, MINIMUM_REQUIREDFields inherited from interface wt.iba.value._IBAHolder
ATTRIBUTE_CONTAINERFields inherited from interface wt.index._Indexable
INDEXER_SETFields inherited from interface wt.sandbox._Interoperable
INTEROP_INFOFields inherited from interface wt.vc._Iterated
BRANCH_IDENTIFIER, CONTROL_BRANCH, CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_INFO, ITERATION_NOTE, LATEST_ITERATION, MASTER, MASTER_REFERENCE, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAMEFields inherited from interface wt.lifecycle._LifeCycleManaged
LIFE_CYCLE_AT_GATE, LIFE_CYCLE_BASIC, LIFE_CYCLE_NAME, LIFE_CYCLE_STATE, LIFE_CYCLE_TEMPLATE, STATEFields inherited from interface wt.locks._Lockable
LOCK, LOCK_DATE, LOCK_NOTE, LOCKED, LOCKER, LOCKER_EMAIL, LOCKER_FULL_NAME, LOCKER_NAMEFields inherited from interface wt.epm.modelitems._ModelItemContainer
ROOT_ITEM, ROOT_ITEM_REFERENCEFields inherited from interface wt.notify._Notifiable
EVENT_SETFields inherited from interface wt.vc._OneOffVersioned
ONE_OFF_VERSION_IDENTIFIER, ONE_OFF_VERSION_INFOFields inherited from interface wt.org._OrganizationOwned
ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIERFields inherited from interface wt.org._OrganizationOwnedVersion
ORGANIZATION_REFERENCEFields inherited from interface wt.ownership._Ownable
OWNERSHIPFields inherited from interface wt.fc._Persistable
PERSIST_INFOFields inherited from interface wt.access._SecurityLabeled
SECURITY_LABELSFields inherited from interface wt.team._TeamManaged
TEAM_ID, TEAM_IDENTITY, TEAM_NAME, TEAM_TEMPLATE_ID, TEAM_TEMPLATE_IDENTITY, TEAM_TEMPLATE_NAMEFields inherited from interface wt.enterprise._Templateable
TEMPLATE, TEMPLATEDFields inherited from interface wt.type._Typed
TYPE_DEFINITION_REFERENCEFields inherited from interface wt.vc._Versioned
VERSION_IDENTIFIER, VERSION_INFOFields inherited from interface wt.vc.wip._Workable
CHECKOUT_INFOFields inherited from interface wt.inf.container._WTContained
CONTAINER, CONTAINER_NAME, CONTAINER_REFERENCEFields inherited from interface wt.fc.BusinessInformation
BUSINESS_TYPE, IDENTITYFields inherited from interface wt.folder.CabinetBased
FOLDER_PATH, LOCATIONFields inherited from interface wt.option.ChoiceMappable
LOADER_CACHE_KEYFields inherited from interface wt.identity.DisplayIdentification
DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPEFields inherited from interface wt.epm.EPMObject
UNSPECIFIEDFields inherited from interface wt.option.Expressionable
LOADER_CACHE_KEYFields inherited from interface wt.org.OrganizationOwned
ORGANIZATIONFields inherited from interface wt.fc.Persistable
IDENTITY, TYPEFields inherited from interface wt.access.SecurityLabeled
SECURITY_LABELS_INTERNAL_VALUEFields inherited from interface wt.projmgmt.deliverable.SubjectOfDeliverable
loggerFields inherited from interface wt.vc.Versioned
MASTER_SERIESFields inherited from interface wt.inf.container.WTContained
CONTAINER_ID -
Method Summary
Modifier and TypeMethodDescriptionGets the value of the attribute: AUTHORING_APPLICATION.Gets the value of the attribute: CADNAME.Gets the value of the attribute: DEFAULT_UNIT.Gets the value of the attribute: DOC_SUB_TYPE.Gets the value of the attribute: DOC_TYPE.getName()Gets the value of the attribute: NAME.Gets the value of the attribute: NUMBER.Gets the value of the attribute: ORGANIZATION.Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER.Gets the value of the attribute: OWNER_APPLICATION.protected voidinitialize(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName) Supports initialization, following construction of an instance.protected voidinitialize(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName, String globalID) Supports initialization, following construction of an instance.protected voidinitialize(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName, QuantityUnit defaultUnit) Supports initialization, following construction of an instance.protected voidinitialize(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName, QuantityUnit defaultUnit, String globalID) Supports initialization, following construction of an instance.booleanGets the value of the attribute: GENERIC.booleanGets the value of the attribute: INSTANCE.booleanGets the value of the attribute: TOP_GENERIC.static EPMDocumentFor internal use.static EPMDocumentnewEPMDocument(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName) Please note that use of this constructor can be very risky.static EPMDocumentnewEPMDocument(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName, String globalID) Please note that use of this constructor can be very risky.static EPMDocumentnewEPMDocument(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType, String CADName, QuantityUnit defaultUnit) Please note that use of this constructor can be very risky.static EPMDocumentnewEPMDocument(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.voidsetCADName(String a_CADName) Sets the value of the attribute: CADNAME.voidsetDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.voidsetDocSubType(EPMDocSubType a_DocSubType) Sets the value of the attribute: DOC_SUB_TYPE.voidsetDocType(EPMDocumentType a_DocType) Sets the value of the attribute: DOC_TYPE.voidsetGeneric(boolean a_Generic) Sets the value of the attribute: GENERIC.voidsetInstance(boolean a_Instance) Sets the value of the attribute: INSTANCE.voidSets the value of the attribute: NAME.voidSets the value of the attribute: NUMBER.voidsetOrganization(WTOrganization a_Organization) Sets the value of the attribute: ORGANIZATION.voidsetPlaceHolder(boolean a_PlaceHolder) Sets the value of the attribute: PLACE_HOLDER.voidsetTopGeneric(boolean a_TopGeneric) Sets the value of the attribute: TOP_GENERIC.Methods inherited from class wt.epm._EPMDocument
getAsStoredConfig, getAsStoredConfigReference, getAttributeContainer, getAuthoringAppVersion, getAuthoringAppVersionReference, getBoxExtents, getClassInfo, getConceptualClassname, getContainer, getContainerName, getContainerReference, getContentVector, getDbKeySize, getDescription, getEffVector, getExpressionData, getFamilyTableStatus, getFederatableInfo, getFormat, getFormatName, getGenericType, getGlobalID, getHttpVector, getInteropInfo, getLengthScale, getMaximumAllowed, getMinimumRequired, getOneOffVersionIdentifier, getOneOffVersionInfo, getOperation, getOrganizationCodingSystem, getOrganizationName, getPrimary, getReferenceControl, getRevisionNumber, getRootItem, getRootItemReference, getTemplate, getType, getTypeDefinitionReference, isCollapsible, isDerived, isExtentsValid, isHasContents, isMissingDependents, isPlaceHolder, isTemplated, isVerified, readExternal, readExternal, readVersion, setAsStoredConfig, setAsStoredConfigReference, setAttributeContainer, setAuthoringAppVersion, setBoxExtents, setCollapsible, setContainer, setContainerReference, setContentVector, setDbKeySize, setDerived, setExpressionData, setExtentsValid, setFamilyTableStatus, setFederatableInfo, setFormat, setGenericType, setHasContents, setHttpVector, setInteropInfo, setLengthScale, setMaximumAllowed, setMinimumRequired, setMissingDependents, setOneOffVersionInfo, setOperation, setPrimary, setReferenceControl, setRevisionNumber, setRootItem, setRootItemReference, setTemplate, setTypeDefinitionReference, setVerified, super_readExternal_EPMDocument, super_readVersion_EPMDocument, super_writeExternal_EPMDocument, writeExternal, writeExternalMethods inherited from class wt.enterprise.RevisionControlled
getBusinessType, getCabinetReference, getCreator, getFolderPath, getIdentity, getIterationDisplayIdentifier, getLocation, getVersionDisplayIdentifier, getVersionDisplayIdentity, getVersionDisplayType, getVersionIdentifier, setIterationInfoMethods inherited from class wt.enterprise._RevisionControlled
getAdministrativeLock, getBranchIdentifier, getCabinet, getCabinetName, getCheckoutInfo, getControlBranch, getCreatorEMail, getCreatorFullName, getCreatorName, getDomainRef, getEntrySet, getEventSet, getFolderingInfo, getIndexerSet, getIterationIdentifier, getIterationInfo, getIterationNote, getLifeCycleName, getLifeCycleState, getLifeCycleTemplate, getLock, getLockDate, getLocker, getLockerEMail, getLockerFullName, getLockerName, getLockNote, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, getOwnership, getParentFolder, getSecurityLabels, getState, getTeamId, getTeamIdentity, getTeamName, getTeamTemplateId, getTeamTemplateIdentity, getTeamTemplateName, getVersionInfo, isHasHangingChange, isHasPendingChange, isHasResultingChange, isHasSuspect, isHasVariance, isInheritedDomain, isLatestIteration, isLifeCycleAtGate, isLifeCycleBasic, isLocked, readVersion, setAdministrativeLock, setCheckoutInfo, setControlBranch, setDomainRef, setEntrySet, setEventSet, setFolderingInfo, setHasHangingChange, setHasPendingChange, setHasResultingChange, setHasSuspect, setHasVariance, setIndexerSet, setInheritedDomain, setLock, setMaster, setMasterReference, setOwnership, setSecurityLabels, setState, setTeamId, setTeamTemplateId, setVersionInfo, super_readExternal_RevisionControlled, super_readVersion_RevisionControlled, super_writeExternal_RevisionControlledMethods inherited from class wt.fc.WTObject
duplicate, getDisplayIdentifier, getDisplayIdentity, getDisplayType, toStringMethods inherited from class wt.fc._WTObject
equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfoMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface wt.vc._Iterated
getBranchIdentifier, getControlBranch, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationInfo, getIterationNote, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, isLatestIteration, setControlBranch, setIterationInfo, setMaster, setMasterReferenceMethods inherited from interface wt.locks._Lockable
getLock, getLockDate, getLocker, getLockerEMail, getLockerFullName, getLockerName, getLockNote, isLocked, setLockMethods inherited from interface wt.ownership._Ownable
getOwnership, setOwnershipMethods inherited from interface wt.fc._Persistable
getPersistInfo, setPersistInfoMethods inherited from interface wt.vc._Versioned
getVersionIdentifier, getVersionInfo, setVersionInfoMethods inherited from interface wt.vc.wip._Workable
getCheckoutInfo, setCheckoutInfoMethods inherited from interface wt.fc.Persistable
getIdentity
-
Method Details
-
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:
getNumberin class_EPMDocument- Returns:
- String
- See Also:
-
setNumber
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:
setNumberin class_EPMDocument- Parameters:
a_Number-- Throws:
WTPropertyVetoException- See Also:
-
getName
Gets the value of the attribute: NAME. The name of the document.
Supported API: true- Specified by:
getNamein interfaceCabinetBased- Specified by:
getNamein interfacewt.projmgmt.deliverable.SubjectOfDeliverable- Overrides:
getNamein class_EPMDocument- Returns:
- String
- See Also:
-
setName
Sets the value of the attribute: NAME. The name of the document.
Supported API: true- Overrides:
setNamein class_EPMDocument- Parameters:
a_Name-- Throws:
WTPropertyVetoException- See Also:
-
getCADName
Gets the value of the attribute: CADNAME. The CAD name of the document.
Supported API: true- Overrides:
getCADNamein class_EPMDocument- Returns:
- String
- See Also:
-
setCADName
Sets the value of the attribute: CADNAME. The CAD name of the document.
Supported API: true- Overrides:
setCADNamein class_EPMDocument- Parameters:
a_CADName-- Throws:
WTPropertyVetoException- See Also:
-
getDocType
Gets the value of the attribute: DOC_TYPE. The type of the document
Supported API: true- Overrides:
getDocTypein class_EPMDocument- Returns:
- EPMDocumentType
- See Also:
-
setDocType
Sets the value of the attribute: DOC_TYPE. The type of the document
Supported API: true- Overrides:
setDocTypein class_EPMDocument- Parameters:
a_DocType-- Throws:
WTPropertyVetoException- See Also:
-
getDocSubType
Gets the value of the attribute: DOC_SUB_TYPE. The subtype of the document
Supported API: true- Overrides:
getDocSubTypein class_EPMDocument- Returns:
- EPMDocSubType
- See Also:
-
setDocSubType
Sets the value of the attribute: DOC_SUB_TYPE. The subtype of the document
Supported API: true- Overrides:
setDocSubTypein class_EPMDocument- Parameters:
a_DocSubType-- Throws:
WTPropertyVetoException- See Also:
-
setPlaceHolder
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:
setPlaceHolderin class_EPMDocument- Parameters:
a_PlaceHolder-- Throws:
WTPropertyVetoException- See Also:
-
setDescription
Sets the value of the attribute: DESCRIPTION. A user-specified description field.
Supported API: true- Overrides:
setDescriptionin class_EPMDocument- Parameters:
a_Description-- Throws:
WTPropertyVetoException- See Also:
-
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:
getOwnerApplicationin interfaceEPMObject- Overrides:
getOwnerApplicationin class_EPMDocument- Returns:
- EPMApplicationType
- See Also:
-
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:
getAuthoringApplicationin interfaceEPMObject- Overrides:
getAuthoringApplicationin class_EPMDocument- Returns:
- EPMAuthoringAppType
- See Also:
-
isGeneric
public boolean isGeneric()Gets the value of the attribute: GENERIC. True if EPMDocument is family table generic.
Supported API: true- Returns:
- boolean
-
setGeneric
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
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
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
Gets the value of the attribute: DEFAULT_UNIT. The default unit of measure for the document.
Supported API: true- Overrides:
getDefaultUnitin class_EPMDocument- Returns:
- QuantityUnit
- See Also:
-
newEPMDocument
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
Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER. The getter for this attribute delivers organization unique identifier.
Supported API: true- Specified by:
getOrganizationUniqueIdentifierin interface_OrganizationOwned- Overrides:
getOrganizationUniqueIdentifierin class_EPMDocument- Returns:
- String
- See Also:
-
getOrganization
Gets the value of the attribute: ORGANIZATION.
Supported API: true- Returns:
- WTOrganization
-
setOrganization
Sets the value of the attribute: ORGANIZATION.
Supported API: true- Parameters:
a_Organization-- Throws:
WTPropertyVetoException
-