wt.epm.ndi
Interface EPMNDDocument

All Superinterfaces:
EPMNDObject
All Known Subinterfaces:
EPMNDDocumentExt

public interface EPMNDDocument
extends EPMNDObject



Supported API: true

Extendable: false


Method Summary
 Collection<EPMNDAttribute> getAttributes()
          Gets the object for the association that plays role: attributes.
 EPMAuthoringAppVersion getAuthoringApplicationVersion()
          Gets the value of the attribute: authoringApplicationVersion.
 EPMNDBoxExtents getBoxExtents()
          Gets the object for the association that plays role: boxExtents.
 String getCadName()
          Gets the value of the attribute: cadName.
 WTContainer getContainer()
          Gets the value of the attribute: container.
 int getDbKeySize()
          Gets the value of the attribute: dbKeySize.
 QuantityUnit getDefaultUnit()
          Gets the value of the attribute: defaultUnit.
 Collection<EPMNDDependency> getDependencies()
          Gets the object for the association that plays role: dependencies.
 ObjectIdentifier getMasterObjectId()
          Gets the value of the attribute: masterObjectId.
 String getNumber()
          Gets the value of the attribute: number.
 WTOrganization getOrganization()
          Gets the value of the attribute: organization.
 ObjectIdentifier getOriginalIterationObjectId()
          Gets the value of the attribute: originalIterationObjectId.
 EPMNDReferenceControl getReferenceControl()
          Gets the object for the association that plays role: referenceControl.
 EPMNDSoftType getSoftType()
          Gets the object for the association that plays role: softType.
 int getUpdateCounter()
          Gets the value of the attribute: updateCounter; Returns update counter for ND document.
 boolean isDerived()
          Gets the value of the attribute: derived; returns true if it is derived document

Supported API: true
 boolean isPlaceHolder()
          Gets the value of the attribute: placeHolder; Indicates if the newly created CAD Document is a placeholder.
 
Methods inherited from interface wt.epm.ndi.EPMNDObject
getObjectId
 

Method Detail

getCadName

String getCadName()
                  throws WTException
Gets the value of the attribute: cadName.

Supported API: true

Returns:
String
Throws:
WTException

getMasterObjectId

ObjectIdentifier getMasterObjectId()
                                   throws WTException
Gets the value of the attribute: masterObjectId.

Supported API: true

Returns:
ObjectIdentifier
Throws:
WTException

getOriginalIterationObjectId

ObjectIdentifier getOriginalIterationObjectId()
                                              throws WTException
Gets the value of the attribute: originalIterationObjectId.

Supported API: true

Returns:
ObjectIdentifier
Throws:
WTException

getAuthoringApplicationVersion

EPMAuthoringAppVersion getAuthoringApplicationVersion()
                                                      throws WTException
Gets the value of the attribute: authoringApplicationVersion.

Supported API: true

Returns:
EPMAuthoringAppVersion
Throws:
WTException

getUpdateCounter

int getUpdateCounter()
                     throws WTException
Gets the value of the attribute: updateCounter; Returns update counter for ND document. If ND document update counter different then EPMDocument update counter overridable conflict will be generated. If ND document update counter equals -1 upload service ignore it value.

Supported API: true

Returns:
int
Throws:
WTException

getNumber

String getNumber()
                 throws WTException
Gets the value of the attribute: number.

Supported API: true

Returns:
String
Throws:
WTException

getContainer

WTContainer getContainer()
                         throws WTException
Gets the value of the attribute: container.

Supported API: true

Returns:
WTContainer
Throws:
WTException

getOrganization

WTOrganization getOrganization()
                               throws WTException
Gets the value of the attribute: organization.

Supported API: true

Returns:
WTOrganization
Throws:
WTException

getDbKeySize

int getDbKeySize()
                 throws WTException
Gets the value of the attribute: dbKeySize.

Supported API: true

Returns:
int
Throws:
WTException

getDefaultUnit

QuantityUnit getDefaultUnit()
                            throws WTException
Gets the value of the attribute: defaultUnit.

Supported API: true

Returns:
QuantityUnit
Throws:
WTException

isPlaceHolder

boolean isPlaceHolder()
                      throws WTException
Gets the value of the attribute: placeHolder; 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

Returns:
boolean
Throws:
WTException

isDerived

boolean isDerived()
                  throws WTException
Gets the value of the attribute: derived; returns true if it is derived document

Supported API: true

Returns:
boolean
Throws:
WTException

getAttributes

Collection<EPMNDAttribute> getAttributes()
                                         throws WTException
Gets the object for the association that plays role: attributes.

Supported API: true

Returns:
Collection
Throws:
WTException

getDependencies

Collection<EPMNDDependency> getDependencies()
                                            throws WTException
Gets the object for the association that plays role: dependencies.

Supported API: true

Returns:
Collection
Throws:
WTException

getReferenceControl

EPMNDReferenceControl getReferenceControl()
                                          throws WTException
Gets the object for the association that plays role: referenceControl.

Supported API: true

Returns:
EPMNDReferenceControl
Throws:
WTException

getSoftType

EPMNDSoftType getSoftType()
                          throws WTException
Gets the object for the association that plays role: softType.

Supported API: true

Returns:
EPMNDSoftType
Throws:
WTException

getBoxExtents

EPMNDBoxExtents getBoxExtents()
                              throws WTException
Gets the object for the association that plays role: boxExtents.

Supported API: true

Returns:
EPMNDBoxExtents
Throws:
WTException