|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectwt.fc.WTObject
wt.enterprise.RevisionControlled
wt.epm.EPMDocument
public class 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
| Field Summary | |
|---|---|
static String |
AUTHORING_APPLICATION
Label for the attribute; Indicates that the named application authored the object. |
static String |
BOX_EXTENTS
Label for the attribute. |
static String |
CADNAME
Label for the attribute; The CAD name of the document. |
static String |
DEFAULT_UNIT
Label for the attribute; The default unit of measure for the document. |
static String |
DESCRIPTION
Label for the attribute; A user-specified description field. |
static String |
DOC_SUB_TYPE
Label for the attribute; The subtype of the document Supported API: true |
static String |
DOC_TYPE
Label for the attribute; The type of the document Supported API: true |
static String |
EXTENTS_VALID
Label for the attribute; Indicator of the validity of the current EPMBoxExtents. |
static String |
FAMILY_TABLE_STATUS
Label for the attribute. |
static String |
GENERIC
Label for the attribute; True if EPMDocument is family table generic. |
static String |
INSTANCE
Label for the attribute; True if EPMDocument is family table instance. |
static String |
MISSING_DEPENDENTS
Label for the attribute; Flag to indicate if some of the dependencies of the CADModel are missing. |
static String |
NAME
Label for the attribute; The name of the document. |
static String |
NUMBER
Label for the attribute; The number attribute represents the number for this document and all of its versions. |
static String |
OWNER_APPLICATION
Label for the attribute; Indicate that the named application owns the object. |
static String |
PLACE_HOLDER
Label for the attribute; Indicates if the newly created CAD Document is a placeholder. |
static String |
TOP_GENERIC
Label for the attribute; True if EPMDocument is family table top generic. |
| Fields inherited from class wt.enterprise.RevisionControlled |
|---|
MASTER |
| Fields inherited from interface wt.org.OrganizationOwnedVersion |
|---|
MASTER, MASTER_REFERENCE |
| Fields inherited from interface wt.org.OrganizationOwned |
|---|
ORGANIZATION, ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER |
| Method Summary | |
|---|---|
void |
checkAttributes()
Validate the values of this Persistable object's attributes. |
EPMAuthoringAppType |
getAuthoringApplication()
Gets the value of the attribute: AUTHORING_APPLICATION. |
EPMBoxExtents |
getBoxExtents()
Gets the object for the association that plays role: BOX_EXTENTS. |
String |
getCADName()
Gets the value of the attribute: CADNAME. |
QuantityUnit |
getDefaultUnit()
Gets the value of the attribute: DEFAULT_UNIT. |
String |
getDescription()
Gets the value of the attribute: DESCRIPTION. |
EPMDocSubType |
getDocSubType()
Gets the value of the attribute: DOC_SUB_TYPE. |
EPMDocumentType |
getDocType()
Gets the value of the attribute: DOC_TYPE. |
int |
getFamilyTableStatus()
Gets the value of the attribute: FAMILY_TABLE_STATUS. |
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 |
getOrganizationCodingSystem()
Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM. |
String |
getOrganizationName()
Gets the value of the attribute: ORGANIZATION_NAME. |
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,
QuantityUnit defaultUnit)
Supports initialization, following construction of an instance. |
boolean |
isExtentsValid()
Gets the value of the attribute: EXTENTS_VALID. |
boolean |
isGeneric()
Gets the value of the attribute: GENERIC. |
boolean |
isInstance()
Gets the value of the attribute: INSTANCE. |
boolean |
isMissingDependents()
Gets the value of the attribute: MISSING_DEPENDENTS. |
boolean |
isPlaceHolder()
Gets the value of the attribute: PLACE_HOLDER. |
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)
Supported API: true |
static EPMDocument |
newEPMDocument(String number,
String name,
EPMAuthoringAppType authoringApp,
EPMDocumentType docType,
String CADName,
QuantityUnit defaultUnit)
Supported API: true |
void |
setBoxExtents(EPMBoxExtents a_BoxExtents)
Sets the object for the association that plays role: BOX_EXTENTS. |
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 |
setExtentsValid(boolean a_ExtentsValid)
Sets the value of the attribute: EXTENTS_VALID. |
void |
setFamilyTableStatus(int a_FamilyTableStatus)
Sets the value of the attribute: FAMILY_TABLE_STATUS. |
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 |
setMissingDependents(boolean a_MissingDependents)
Sets the value of the attribute: MISSING_DEPENDENTS. |
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.enterprise.RevisionControlled |
|---|
getControlBranch, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationNote, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, isLatestIteration, setControlBranch, 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.org.OrganizationOwnedVersion |
|---|
getMaster, getMasterReference |
| Field Detail |
|---|
public static final String NUMBER
public static final String NAME
public static final String EXTENTS_VALID
public static final String CADNAME
public static final String DOC_TYPE
public static final String DOC_SUB_TYPE
public static final String MISSING_DEPENDENTS
public static final String PLACE_HOLDER
public static final String DESCRIPTION
public static final String OWNER_APPLICATION
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
public static final String AUTHORING_APPLICATION
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
public static final String FAMILY_TABLE_STATUS
public static final String GENERIC
public static final String INSTANCE
public static final String TOP_GENERIC
public static final String DEFAULT_UNIT
public static final String BOX_EXTENTS
| Method Detail |
|---|
public String getNumber()
public void setNumber(String a_Number)
throws WTPropertyVetoException
a_Number -
WTPropertyVetoExceptionpublic String getName()
public void setName(String a_Name)
throws WTPropertyVetoException
a_Name -
WTPropertyVetoExceptionpublic boolean isExtentsValid()
public void setExtentsValid(boolean a_ExtentsValid)
throws WTPropertyVetoException
a_ExtentsValid -
WTPropertyVetoExceptionpublic String getCADName()
public void setCADName(String a_CADName)
throws WTPropertyVetoException
a_CADName -
WTPropertyVetoExceptionpublic EPMDocumentType getDocType()
public void setDocType(EPMDocumentType a_DocType)
throws WTPropertyVetoException
a_DocType -
WTPropertyVetoExceptionpublic EPMDocSubType getDocSubType()
public void setDocSubType(EPMDocSubType a_DocSubType)
throws WTPropertyVetoException
a_DocSubType -
WTPropertyVetoExceptionpublic boolean isMissingDependents()
public void setMissingDependents(boolean a_MissingDependents)
throws WTPropertyVetoException
a_MissingDependents -
WTPropertyVetoExceptionpublic boolean isPlaceHolder()
public void setPlaceHolder(boolean a_PlaceHolder)
throws WTPropertyVetoException
a_PlaceHolder -
WTPropertyVetoExceptionpublic String getDescription()
public void setDescription(String a_Description)
throws WTPropertyVetoException
a_Description -
WTPropertyVetoExceptionpublic EPMApplicationType getOwnerApplication()
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
getOwnerApplication in interface EPMObjectpublic EPMAuthoringAppType getAuthoringApplication()
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
getAuthoringApplication in interface EPMObjectpublic int getFamilyTableStatus()
public void setFamilyTableStatus(int a_FamilyTableStatus)
throws WTPropertyVetoException
a_FamilyTableStatus -
WTPropertyVetoExceptionpublic boolean isGeneric()
public void setGeneric(boolean a_Generic)
throws WTPropertyVetoException
a_Generic -
WTPropertyVetoExceptionpublic boolean isInstance()
public void setInstance(boolean a_Instance)
throws WTPropertyVetoException
a_Instance -
WTPropertyVetoExceptionpublic boolean isTopGeneric()
public void setTopGeneric(boolean a_TopGeneric)
throws WTPropertyVetoException
a_TopGeneric -
WTPropertyVetoExceptionpublic QuantityUnit getDefaultUnit()
public EPMBoxExtents getBoxExtents()
public void setBoxExtents(EPMBoxExtents a_BoxExtents)
a_BoxExtents -
public static EPMDocument newEPMDocument()
throws WTException
WTException
public static EPMDocument newEPMDocument(String number,
String name,
EPMAuthoringAppType authoringApp,
EPMDocumentType docType,
String CADName)
throws WTException
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 -
WTException
protected void initialize(String number,
String name,
EPMAuthoringAppType authoringApp,
EPMDocumentType docType,
String CADName)
throws WTException
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 -
WTException
public static EPMDocument newEPMDocument(String number,
String name,
EPMAuthoringAppType authoringApp,
EPMDocumentType docType,
String CADName,
QuantityUnit defaultUnit)
throws WTException
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 -
WTException
protected void initialize(String number,
String name,
EPMAuthoringAppType authoringApp,
EPMDocumentType docType,
String CADName,
QuantityUnit defaultUnit)
throws WTException
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 -
WTException
public void checkAttributes()
throws InvalidAttributeException
In particular, this must check that the modifications to the object
were made by an approved application.
Supported API: true
checkAttributes in interface EPMObjectInvalidAttributeExceptionpublic String getOrganizationUniqueIdentifier()
getOrganizationUniqueIdentifier in interface OrganizationOwnedpublic String getOrganizationCodingSystem()
getOrganizationCodingSystem in interface OrganizationOwnedpublic String getOrganizationName()
getOrganizationName in interface OrganizationOwnedpublic WTOrganization getOrganization()
getOrganization in interface OrganizationOwned
public void setOrganization(WTOrganization a_Organization)
throws WTPropertyVetoException
a_Organization -
WTPropertyVetoException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||