Package wt.epm
Class EPMDocumentMaster
java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.enterprise._Master
wt.enterprise.Master
wt.epm._EPMDocumentMaster
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
@GenAsPersistable(superClass=Master.class,interfaces={DocumentMaster.class,UniquelyIdentified.class,EPMObject.class,wt.ufid.Federatable.class,OrganizationOwnedMaster.class,WTContainedIdentified.class,wt.type.Typed.class,wt.build.BuildSourceMaster.class,wt.representation.RepresentableMaster.class,wt.inf.container.WTContainedFilterable.class,EPMDependencyMaster.class,wt.generic.GenericizableMaster.class,OptionSetAssignable.class,wt.projmgmt.deliverable.MasteredSubjectOfDeliverable.class},versions={-7079988827139988606L,177466932261223087L},properties={@GeneratedProperty(name="number",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="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.",constraints=@PropertyConstraints(changeable=VIA_OTHER_MEANS,required=true,stringCase=UPPER_CASE),columnProperties=@ColumnProperties(index=true,columnName="documentNumber")),@GeneratedProperty(name="name",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="The name of the document.",constraints=@PropertyConstraints(changeable=VIA_OTHER_MEANS,upperLimit=400,required=true)),@GeneratedProperty(name="CADName",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="TheCAD Name of the document.t.",constraints=@PropertyConstraints(changeable=VIA_OTHER_MEANS,required=true),columnProperties=@ColumnProperties(index=true)),@GeneratedProperty(name="ownerApplication",type=EPMApplicationType.class,supportedAPI=PUBLIC,javaDoc="Indicate that the named application owns the object. <p> The parameter is an EPMApplicationType, so that any sort of checking can be done at run-time.",constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(persistent=true)),@GeneratedProperty(name="authoringApplication",type=EPMAuthoringAppType.class,supportedAPI=PUBLIC,javaDoc="Indicates that the named application authored the object. <p> The parameter is an EPMAuthoringAppType, so that any sort of checking can be done at run-time.",constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(persistent=true)),@GeneratedProperty(name="docType",type=EPMDocumentType.class,supportedAPI=PUBLIC,constraints=@PropertyConstraints(changeable=FROZEN,required=true)),@GeneratedProperty(name="docSubType",type=EPMDocSubType.class,supportedAPI=PUBLIC),@GeneratedProperty(name="defaultUnit",type=QuantityUnit.class,initialValue="wt.part.QuantityUnit.EA",supportedAPI=PUBLIC,javaDoc="The default unit of measurement assigned to the document when it is used in a structure.",constraints=@PropertyConstraints(upperLimit=30,required=true)),@GeneratedProperty(name="globalID",type=java.lang.String.class,supportedAPI=PRIVATE,javaDoc="The globalID of the document.",columnProperties=@ColumnProperties(persistent=true),accessors=@PropertyAccessors(setAccess=PROTECTED))},tableProperties=@TableProperties(compositeIndex1="+UPPER(CADName)",compositeIndex2="+REVERSE(UPPER(name))",compositeIndex3="+REVERSE(UPPER(CADName))",compositeIndex4="+REVERSE(documentNumber)",compositeIndex9="+UPPER(name)",compositeUnique1="+ NVL( globalID, idA2A2 )"),iconProperties=@IconProperties(standardIcon="wt/clients/images/epmdocms.gif",openIcon="wt/clients/images/epmdocms.gif"))
public class EPMDocumentMaster
extends _EPMDocumentMaster
The Master of an EPMDocument. It has a name and number, the latter of
which must be unique, and is paired to a EPMDocument.
Use the newEPMDocumentMaster static factory method(s), not
the EPMDocumentMaster constructor, to construct instances
of this class. Instances must be constructed using the static factory(s),
in order to ensure proper initialization of the instance.
Supported API: true
Extendable: false
- See Also:
-
Field Summary
Fields inherited from class wt.epm._EPMDocumentMaster
AUTHORING_APPLICATION, CADNAME, DEFAULT_UNIT, DOC_SUB_TYPE, DOC_TYPE, NAME, NUMBER, OWNER_APPLICATIONFields inherited from interface wt.org._OrganizationOwned
ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIERFields inherited from interface wt.org._OrganizationOwnedImpl
ORGANIZATION_REFERENCE -
Method Summary
Modifier and TypeMethodDescriptionvoidValidates the values of the required attributes.Gets the value of the attribute: ORGANIZATION.Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER.voidsetAuthoringApplication(EPMAuthoringAppType a_AuthoringApplication) Sets the value of the attribute: AUTHORING_APPLICATION.voidsetCADName(String a_CADName) Sets the value of the attribute: CADNAME.voidsetDocSubType(EPMDocSubType a_DocSubType) Sets the object for the association that plays role: DOC_SUB_TYPE.voidsetDocType(EPMDocumentType a_DocType) Sets the object for the association that plays role: DOC_TYPE.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.voidsetOwnerApplication(EPMApplicationType a_OwnerApplication) Sets the value of the attribute: OWNER_APPLICATION.Methods inherited from class wt.epm._EPMDocumentMaster
getAuthoringApplication, getCADName, getDefaultUnit, getDocSubType, getDocType, getName, getNumber, getOrganizationCodingSystem, getOrganizationName, getOrganizationReference, getOwnerApplication, setDefaultUnit, setOrganizationReferenceMethods inherited from class wt.fc.WTObject
getDisplayIdentifier, getDisplayIdentity, getDisplayType
-
Method Details
-
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 EPMSocument, it is actually implemented on the master.
Supported API: true- Overrides:
setNumberin class_EPMDocumentMaster- Parameters:
a_Number-- Throws:
WTPropertyVetoException- See Also:
-
setName
Sets the value of the attribute: NAME. The name of the document.
Supported API: true- Overrides:
setNamein class_EPMDocumentMaster- Parameters:
a_Name-- Throws:
WTPropertyVetoException- See Also:
-
setCADName
Sets the value of the attribute: CADNAME. TheCAD Name of the document.t.
Supported API: true- Overrides:
setCADNamein class_EPMDocumentMaster- Parameters:
a_CADName-- Throws:
WTPropertyVetoException- See Also:
-
setOwnerApplication
public void setOwnerApplication(EPMApplicationType a_OwnerApplication) throws WTPropertyVetoException Sets the value of the attribute: OWNER_APPLICATION. Indicate that the named application owns the object.The parameter is an EPMApplicationType, so that any sort of checking can be done at run-time.
Supported API: true- Overrides:
setOwnerApplicationin class_EPMDocumentMaster- Parameters:
a_OwnerApplication-- Throws:
WTPropertyVetoException- See Also:
-
setAuthoringApplication
public void setAuthoringApplication(EPMAuthoringAppType a_AuthoringApplication) throws WTPropertyVetoException Sets the value of the attribute: AUTHORING_APPLICATION. Indicates that the named application authored the object.The parameter is an EPMAuthoringAppType, so that any sort of checking can be done at run-time.
Supported API: true- Overrides:
setAuthoringApplicationin class_EPMDocumentMaster- Parameters:
a_AuthoringApplication-- Throws:
WTPropertyVetoException- See Also:
-
setDocType
Sets the object for the association that plays role: DOC_TYPE.
Supported API: true- Overrides:
setDocTypein class_EPMDocumentMaster- Parameters:
a_DocType-- Throws:
WTPropertyVetoException- See Also:
-
setDocSubType
Sets the object for the association that plays role: DOC_SUB_TYPE.
Supported API: true- Overrides:
setDocSubTypein class_EPMDocumentMaster- Parameters:
a_DocSubType-- Throws:
WTPropertyVetoException- See Also:
-
checkAttributes
Validates the values of the required attributes.
Supported API: true- Specified by:
checkAttributesin interfaceEPMObject- Specified by:
checkAttributesin interfacePersistable- Overrides:
checkAttributesin classWTObject- Throws:
InvalidAttributeException
-
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_EPMDocumentMaster- 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
-