wt.epm
Class EPMDocumentMaster

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.Master
          wt.epm.EPMDocumentMaster

All Implemented Interfaces:

BuildSourceMaster, BusinessInformation, DisplayIdentification, Document, DocumentMaster, ElectronicallySignable, EPMObject, Externalizable, Federatable, IBAHolder, Identified, Mastered, NetFactor, ObjectMappable, OrganizationOwned, OrganizationOwnedImpl, OrganizationOwnedMaster, Persistable, RecentlyVisited, RemotelyLinkable, RepresentableMaster, RepresentablesAndMasters, Serializable, Typed, UniquelyIdentified, WTContained, WTContainedIdentified

public class EPMDocumentMaster

extends Master

implements DocumentMaster, UniquelyIdentified, EPMObject, Federatable, OrganizationOwnedMaster, WTContainedIdentified, Typed, BuildSourceMaster, RepresentableMaster, Externalizable

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:

Serialized Form

Field Summary

static String	AUTHORING_APPLICATION Label for the attribute; Indicates that the named application authored the object.
private static int	AUTHORING_APPLICATION_UPPER_LIMIT
private EPMAuthoringAppType	authoringApplication
private String	CADName
static String	CADNAME Label for the attribute; TheCAD Name of the document.t.
private static int	CADNAME_UPPER_LIMIT
private static String	CLASSNAME
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
static String	DEFAULT_UNIT Label for the attribute; The default unit of measurement assigned to the document when it is used in a structure.
private static int	DEFAULT_UNIT_UPPER_LIMIT
private QuantityUnit	defaultUnit
static String	DOC_SUB_TYPE Label for the attribute.
private static int	DOC_SUB_TYPE_UPPER_LIMIT
static String	DOC_TYPE Label for the attribute.
private static int	DOC_TYPE_UPPER_LIMIT
private EPMDocSubType	docSubType
private EPMDocumentType	docType
private static String	EPMRESOURCE
static long	EXTERNALIZATION_VERSION_UID
private FederatableInfo	federatableInfo
private String	name
static String	NAME Label for the attribute; The name of the document.
private static int	NAME_UPPER_LIMIT
private String	number
static String	NUMBER Label for the attribute; The number attribute represents the number for this document and all of its versions.
private static int	NUMBER_UPPER_LIMIT
static String	OCCURRENCE_TABLE Label for the attribute.
static String	OCCURRENCE_TABLE_REFERENCE Label for the attribute.
private ObjectReference	occurrenceTableReference
protected static long	OLD_FORMAT_VERSION_UID
private WTPrincipalReference	organizationReference
static String	OWNER_APPLICATION Label for the attribute; Indicate that the named application owns the object.
private static int	OWNER_APPLICATION_UPPER_LIMIT
private EPMApplicationType	ownerApplication
static long	R51_EXTERNALIZATION_VERSION_UID
static long	R62_EXTERNALIZATION_VERSION_UID
static long	R70_EXTERNALIZATION_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private AttributeContainer	theAttributeContainer
private TypeDefinitionReference	typeDefinitionReference

Fields inherited from class wt.enterprise.Master

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.epm.EPMObject

UNSPECIFIED

Fields inherited from interface wt.ufid.Federatable

FEDERATABLE_INFO

Fields inherited from interface wt.vc.Mastered

SERIES

Fields inherited from interface wt.org.OrganizationOwnedImpl

ORGANIZATION_REFERENCE

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION, ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Fields inherited from interface wt.inf.container.WTContainedIdentified

CONTAINER_REFERENCE

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME

Fields inherited from interface wt.type.Typed

TYPE_DEFINITION_REFERENCE

Fields inherited from interface wt.iba.value.IBAHolder

ATTRIBUTE_CONTAINER

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

EPMDocumentMaster()

Method Summary

private void	authoringApplicationValidate(EPMAuthoringAppType a_AuthoringApplication)
private void	CADNameValidate(String a_CADName)
void	checkAttributes() Validates the values of the required attributes.
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
long	createOccurrenceIdForPath(long[] path) Create a new Occurrrence ID for the specified path.
private void	defaultUnitValidate(QuantityUnit a_DefaultUnit)
private void	docTypeValidate(EPMDocumentType a_DocType)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
private void	federatableInfoValidate(FederatableInfo a_FederatableInfo)
AttributeContainer	getAttributeContainer() Gets the object for the association that plays role: ATTRIBUTE_CONTAINER.
EPMAuthoringAppType	getAuthoringApplication() Gets the value of the attribute: AUTHORING_APPLICATION.
String	getCADName() Gets the value of the attribute: CADNAME.
String	getConceptualClassname() Deprecated.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
QuantityUnit	getDefaultUnit() Gets the object for the association that plays role: DEFAULT_UNIT.
EPMDocSubType	getDocSubType() Gets the object for the association that plays role: DOC_SUB_TYPE.
EPMDocumentType	getDocType() Gets the object for the association that plays role: DOC_TYPE.
FederatableInfo	getFederatableInfo() Gets the object for the association that plays role: FEDERATABLE_INFO.
IdentificationObject	getIdentificationObject() Constructs and returns an identification object.
String	getIdentity() Deprecated. Replaced by getDisplayIdentifier() to return a localizable message which supplies the identifier for the object. To return a localizable value which includes the object type, use getDisplayIdentity(). For general messages, getDisplayIdentity() by itself is prefereble to using a combination of getDisplayType() and getDisplayIdentifier().
String	getName() Gets the value of the attribute: NAME.
String	getNumber() Gets the value of the attribute: NUMBER.
long	getOccurrenceIdForPath(long[] path) Given the path of placed member link identifiers, return the occurrence identifier.
EPMOccurrenceTable	getOccurrenceTable() Gets the object for the association that plays role: OCCURRENCE_TABLE.
ObjectReference	getOccurrenceTableReference() Gets the value of the attribute: OCCURRENCE_TABLE_REFERENCE.
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.
WTPrincipalReference	getOrganizationReference() Gets the value of the attribute: ORGANIZATION_REFERENCE.
String	getOrganizationUniqueIdentifier() Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER.
EPMApplicationType	getOwnerApplication() Gets the value of the attribute: OWNER_APPLICATION.
TypeDefinitionReference	getTypeDefinitionReference() Gets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize(String newNumber, String newName, EPMAuthoringAppType authoringAppl, EPMDocumentType documentType, EPMDocSubType docSubType, String CADName, QuantityUnit defaultUnit)
private void	nameValidate(String a_Name)
static EPMDocumentMaster	newEPMDocumentMaster() Default factory for the class.
private void	numberValidate(String a_Number)
private void	occurrenceTableReferenceValidate(ObjectReference a_OccurrenceTableReference)
private void	organizationReferenceValidate(WTPrincipalReference a_OrganizationReference)
private void	ownerApplicationValidate(EPMApplicationType a_OwnerApplication)
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(EPMDocumentMaster thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAttributeContainer(AttributeContainer a_AttributeContainer) Sets the object for the association that plays role: ATTRIBUTE_CONTAINER.
void	setAuthoringApplication(EPMAuthoringAppType a_AuthoringApplication) Sets the value of the attribute: AUTHORING_APPLICATION.
void	setCADName(String a_CADName) Sets the value of the attribute: CADNAME.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
void	setDefaultUnit(QuantityUnit a_DefaultUnit) Sets the object for the association that plays role: DEFAULT_UNIT.
void	setDocSubType(EPMDocSubType a_DocSubType) Sets the object for the association that plays role: DOC_SUB_TYPE.
void	setDocType(EPMDocumentType a_DocType) Sets the object for the association that plays role: DOC_TYPE.
void	setFederatableInfo(FederatableInfo a_FederatableInfo) Sets the object for the association that plays role: FEDERATABLE_INFO.
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	setOccurrenceTable(EPMOccurrenceTable a_OccurrenceTable) Sets the object for the association that plays role: OCCURRENCE_TABLE.
void	setOccurrenceTableReference(ObjectReference a_OccurrenceTableReference) Sets the value of the attribute: OCCURRENCE_TABLE_REFERENCE.
void	setOrganization(WTOrganization a_Organization) Sets the value of the attribute: ORGANIZATION.
void	setOrganizationReference(WTPrincipalReference a_OrganizationReference) Sets the value of the attribute: ORGANIZATION_REFERENCE.
void	setOwnerApplication(EPMApplicationType a_OwnerApplication) Sets the value of the attribute: OWNER_APPLICATION.
void	setTypeDefinitionReference(TypeDefinitionReference a_TypeDefinitionReference) Sets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.
private void	typeDefinitionReferenceValidate(TypeDefinitionReference a_TypeDefinitionReference)
protected void	updateCADName(String a_CADName)
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class wt.enterprise.Master

getBusinessType, getSeries, readVersion, setSeries

Methods inherited from class wt.fc.WTObject

duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, initialize, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.fc.Persistable

getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Methods inherited from interface wt.vc.Mastered

getSeries, setSeries

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

NUMBER

public static final String NUMBER

Label for the attribute; 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

See Also:

Constant Field Values

NUMBER_UPPER_LIMIT

private static int NUMBER_UPPER_LIMIT

number

private String number

NAME

public static final String NAME

Label for the attribute; The name of the document.

Supported API: true

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

CADNAME

public static final String CADNAME

Label for the attribute; TheCAD Name of the document.t.

Supported API: true

See Also:

Constant Field Values

CADNAME_UPPER_LIMIT

private static int CADNAME_UPPER_LIMIT

CADName

private String CADName

OWNER_APPLICATION

public static final String OWNER_APPLICATION

Label for the attribute; 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

See Also:

Constant Field Values

OWNER_APPLICATION_UPPER_LIMIT

private static int OWNER_APPLICATION_UPPER_LIMIT

ownerApplication

private EPMApplicationType ownerApplication

AUTHORING_APPLICATION

public static final String AUTHORING_APPLICATION

Label for the attribute; 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

See Also:

Constant Field Values

AUTHORING_APPLICATION_UPPER_LIMIT

private static int AUTHORING_APPLICATION_UPPER_LIMIT

authoringApplication

private EPMAuthoringAppType authoringApplication

OCCURRENCE_TABLE

public static final String OCCURRENCE_TABLE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

OCCURRENCE_TABLE_REFERENCE

public static final String OCCURRENCE_TABLE_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

occurrenceTableReference

private ObjectReference occurrenceTableReference

DOC_TYPE

public static final String DOC_TYPE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

DOC_TYPE_UPPER_LIMIT

private static int DOC_TYPE_UPPER_LIMIT

docType

private EPMDocumentType docType

DOC_SUB_TYPE

public static final String DOC_SUB_TYPE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

DOC_SUB_TYPE_UPPER_LIMIT

private static int DOC_SUB_TYPE_UPPER_LIMIT

docSubType

private EPMDocSubType docSubType

DEFAULT_UNIT

public static final String DEFAULT_UNIT

Label for the attribute; The default unit of measurement assigned to the document when it is used in a structure.

Supported API: true

See Also:

Constant Field Values

DEFAULT_UNIT_UPPER_LIMIT

private static int DEFAULT_UNIT_UPPER_LIMIT

defaultUnit

private QuantityUnit defaultUnit

federatableInfo

private FederatableInfo federatableInfo

organizationReference

private WTPrincipalReference organizationReference

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

typeDefinitionReference

private TypeDefinitionReference typeDefinitionReference

theAttributeContainer

private AttributeContainer theAttributeContainer

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

EPMRESOURCE

private static final String EPMRESOURCE

See Also:

Constant Field Values

R51_EXTERNALIZATION_VERSION_UID

public static final long R51_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

R62_EXTERNALIZATION_VERSION_UID

public static final long R62_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

R70_EXTERNALIZATION_VERSION_UID

public static final long R70_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

EPMDocumentMaster

public EPMDocumentMaster()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class Master

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class Master

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(EPMDocumentMaster thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class Master

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class Master

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

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

Supported API: true

Returns:

String

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

Supported API: true

Parameters:

a_Number -

Throws:

WTPropertyVetoException

numberValidate

private void numberValidate(String a_Number)
                     throws WTPropertyVetoException

Parameters:

a_Number -

Throws:

WTPropertyVetoException

getName

public String getName()

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

Supported API: true

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

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

Supported API: true

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getCADName

public String getCADName()

Gets the value of the attribute: CADNAME. TheCAD Name of the document.t.

Supported API: true

Returns:

String

setCADName

public void setCADName(String a_CADName)
                throws WTPropertyVetoException

Sets the value of the attribute: CADNAME. TheCAD Name of the document.t.

Supported API: true

Parameters:

a_CADName -

Throws:

WTPropertyVetoException

CADNameValidate

private void CADNameValidate(String a_CADName)
                      throws WTPropertyVetoException

Parameters:

a_CADName -

Throws:

WTPropertyVetoException

getOwnerApplication

public EPMApplicationType getOwnerApplication()

Gets 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

Specified by:

getOwnerApplication in interface EPMObject

Returns:

EPMApplicationType

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

Parameters:

a_OwnerApplication -

Throws:

WTPropertyVetoException

ownerApplicationValidate

private void ownerApplicationValidate(EPMApplicationType a_OwnerApplication)
                               throws WTPropertyVetoException

Parameters:

a_OwnerApplication -

Throws:

WTPropertyVetoException

getAuthoringApplication

public EPMAuthoringAppType getAuthoringApplication()

Gets 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

Specified by:

getAuthoringApplication in interface EPMObject

Returns:

EPMAuthoringAppType

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

Parameters:

a_AuthoringApplication -

Throws:

WTPropertyVetoException

authoringApplicationValidate

private void authoringApplicationValidate(EPMAuthoringAppType a_AuthoringApplication)
                                   throws WTPropertyVetoException

Parameters:

a_AuthoringApplication -

Throws:

WTPropertyVetoException

getOccurrenceTable

public EPMOccurrenceTable getOccurrenceTable()
                                      throws WTException

Gets the object for the association that plays role: OCCURRENCE_TABLE.

Supported API: false

Returns:

EPMOccurrenceTable

Throws:

WTException

setOccurrenceTable

public void setOccurrenceTable(EPMOccurrenceTable a_OccurrenceTable)
                        throws WTPropertyVetoException,
                               WTException

Sets the object for the association that plays role: OCCURRENCE_TABLE.

Supported API: false

Parameters:

a_OccurrenceTable -

Throws:

WTPropertyVetoException

WTException

getOccurrenceTableReference

public ObjectReference getOccurrenceTableReference()

Gets the value of the attribute: OCCURRENCE_TABLE_REFERENCE.

Supported API: false

Returns:

ObjectReference

setOccurrenceTableReference

public void setOccurrenceTableReference(ObjectReference a_OccurrenceTableReference)
                                 throws WTPropertyVetoException

Sets the value of the attribute: OCCURRENCE_TABLE_REFERENCE.

Supported API: false

Parameters:

a_OccurrenceTableReference -

Throws:

WTPropertyVetoException

occurrenceTableReferenceValidate

private void occurrenceTableReferenceValidate(ObjectReference a_OccurrenceTableReference)
                                       throws WTPropertyVetoException

Parameters:

a_OccurrenceTableReference -

Throws:

WTPropertyVetoException

getDocType

public EPMDocumentType getDocType()

Gets the object for the association that plays role: DOC_TYPE.

Supported API: true

Returns:

EPMDocumentType

setDocType

public void setDocType(EPMDocumentType a_DocType)
                throws WTPropertyVetoException

Sets the object for the association that plays role: DOC_TYPE.

Supported API: true

Parameters:

a_DocType -

Throws:

WTPropertyVetoException

docTypeValidate

private void docTypeValidate(EPMDocumentType a_DocType)
                      throws WTPropertyVetoException

Parameters:

a_DocType -

Throws:

WTPropertyVetoException

getDocSubType

public EPMDocSubType getDocSubType()

Gets the object for the association that plays role: DOC_SUB_TYPE.

Supported API: true

Returns:

EPMDocSubType

setDocSubType

public void setDocSubType(EPMDocSubType a_DocSubType)
                   throws WTPropertyVetoException

Sets the object for the association that plays role: DOC_SUB_TYPE.

Supported API: true

Parameters:

a_DocSubType -

Throws:

WTPropertyVetoException

getDefaultUnit

public QuantityUnit getDefaultUnit()

Gets the object for the association that plays role: DEFAULT_UNIT. The default unit of measurement assigned to the document when it is used in a structure.

Supported API: true

Returns:

QuantityUnit

setDefaultUnit

public void setDefaultUnit(QuantityUnit a_DefaultUnit)
                    throws WTPropertyVetoException

Sets the object for the association that plays role: DEFAULT_UNIT. The default unit of measurement assigned to the document when it is used in a structure.

Supported API: true

Parameters:

a_DefaultUnit -

Throws:

WTPropertyVetoException

defaultUnitValidate

private void defaultUnitValidate(QuantityUnit a_DefaultUnit)
                          throws WTPropertyVetoException

Parameters:

a_DefaultUnit -

Throws:

WTPropertyVetoException

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validates the values of the required attributes.

Supported API: true

Specified by:

checkAttributes in interface Persistable

Overrides:

checkAttributes in class WTObject

Throws:

InvalidAttributeException

getIdentity

public String getIdentity()

Deprecated. Replaced by getDisplayIdentifier() to return a localizable message which supplies the identifier for the object. To return a localizable value which includes the object type, use getDisplayIdentity(). For general messages, getDisplayIdentity() by itself is prefereble to using a combination of getDisplayType() and getDisplayIdentifier().

Returns a string that can be displayed to the user to identify the object. WTObject implements a default method that returns a string representation of this object's identifier.

Supported API: false

Specified by:

getIdentity in interface Persistable

Overrides:

getIdentity in class Master

Returns:

String

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException

Constructs and returns an identification object. This method is the only way to obtain an identification object.

Supported API: false

Specified by:

getIdentificationObject in interface Identified

Returns:

IdentificationObject

Throws:

WTException

getOccurrenceIdForPath

public long getOccurrenceIdForPath(long[] path)
                            throws WTException

Given the path of placed member link identifiers, return the occurrence identifier.

Supported API: false

Parameters:

path - An array of UniqueLinkID values from the EPMDependencyLinks starting at this EPMDocument and connecting to the other EPMDocument.

Returns:

long

Throws:

WTException

createOccurrenceIdForPath

public long createOccurrenceIdForPath(long[] path)
                               throws WTException

Create a new Occurrrence ID for the specified path. If one already exists, throw an exception.

Supported API: false

Parameters:

path - An array of UniqueLinkID values from the EPMDependencyLinks starting at this EPMDocument and connecting to the other EPMDocument.

Returns:

long

Throws:

WTException

newEPMDocumentMaster

public static EPMDocumentMaster newEPMDocumentMaster()
                                              throws WTException

Default factory for the class.

Supported API: false

Returns:

EPMDocumentMaster

Throws:

WTException

getFederatableInfo

public FederatableInfo getFederatableInfo()

Gets the object for the association that plays role: FEDERATABLE_INFO.

Supported API: false

Specified by:

getFederatableInfo in interface Federatable

Returns:

FederatableInfo

setFederatableInfo

public void setFederatableInfo(FederatableInfo a_FederatableInfo)
                        throws WTPropertyVetoException

Sets the object for the association that plays role: FEDERATABLE_INFO.

Supported API: false

Specified by:

setFederatableInfo in interface Federatable

Parameters:

a_FederatableInfo -

Throws:

WTPropertyVetoException

federatableInfoValidate

private void federatableInfoValidate(FederatableInfo a_FederatableInfo)
                              throws WTPropertyVetoException

Parameters:

a_FederatableInfo -

Throws:

WTPropertyVetoException

getOrganizationReference

public WTPrincipalReference getOrganizationReference()

Gets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: false

Specified by:

getOrganizationReference in interface OrganizationOwnedImpl

Returns:

WTPrincipalReference

setOrganizationReference

public void setOrganizationReference(WTPrincipalReference a_OrganizationReference)
                              throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: false

Specified by:

setOrganizationReference in interface OrganizationOwnedImpl

Parameters:

a_OrganizationReference -

Throws:

WTPropertyVetoException

organizationReferenceValidate

private void organizationReferenceValidate(WTPrincipalReference a_OrganizationReference)
                                    throws WTPropertyVetoException

Parameters:

a_OrganizationReference -

Throws:

WTPropertyVetoException

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

Returns:

String

getOrganizationCodingSystem

public String getOrganizationCodingSystem()

Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM. The getter for this attribute delivers organization coding system.

Supported API: true

Specified by:

getOrganizationCodingSystem in interface OrganizationOwned

Returns:

String

getOrganizationName

public String getOrganizationName()

Gets the value of the attribute: ORGANIZATION_NAME. The getter for this attribute delivers organization name.

Supported API: true

Specified by:

getOrganizationName in interface OrganizationOwned

Returns:

String

getOrganization

public WTOrganization getOrganization()

Gets the value of the attribute: ORGANIZATION.

Supported API: true

Specified by:

getOrganization in interface OrganizationOwned

Returns:

WTOrganization

setOrganization

public void setOrganization(WTOrganization a_Organization)
                     throws WTPropertyVetoException

Sets the value of the attribute: ORGANIZATION.

Supported API: true

Specified by:

setOrganization in interface OrganizationOwned

Parameters:

a_Organization -

Throws:

WTPropertyVetoException

getContainer

public WTContainer getContainer()

Gets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:

getContainer in interface WTContainedIdentified

Returns:

WTContainer

setContainer

public void setContainer(WTContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException

Sets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:

setContainer in interface WTContainedIdentified

Parameters:

a_Container -

Throws:

WTPropertyVetoException

WTException

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

getContainerReference in interface WTContainedIdentified

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

setContainerReference in interface WTContainedIdentified

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

getContainerName

public String getContainerName()

Gets the value of the attribute: CONTAINER_NAME. The name of the WTContainer this object is assigned to.

Supported API: false

Specified by:

getContainerName in interface WTContained

Returns:

String

getTypeDefinitionReference

public TypeDefinitionReference getTypeDefinitionReference()

Gets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.

Supported API: false

Specified by:

getTypeDefinitionReference in interface Typed

Returns:

TypeDefinitionReference

setTypeDefinitionReference

public void setTypeDefinitionReference(TypeDefinitionReference a_TypeDefinitionReference)
                                throws WTPropertyVetoException

Sets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.

Supported API: false

Specified by:

setTypeDefinitionReference in interface Typed

Parameters:

a_TypeDefinitionReference -

Throws:

WTPropertyVetoException

typeDefinitionReferenceValidate

private void typeDefinitionReferenceValidate(TypeDefinitionReference a_TypeDefinitionReference)
                                      throws WTPropertyVetoException

Parameters:

a_TypeDefinitionReference -

Throws:

WTPropertyVetoException

getAttributeContainer

public AttributeContainer getAttributeContainer()

Gets the object for the association that plays role: ATTRIBUTE_CONTAINER.

Supported API: false

Specified by:

getAttributeContainer in interface IBAHolder

Returns:

AttributeContainer

setAttributeContainer

public void setAttributeContainer(AttributeContainer a_AttributeContainer)

Sets the object for the association that plays role: ATTRIBUTE_CONTAINER.

Supported API: false

Specified by:

setAttributeContainer in interface IBAHolder

Parameters:

a_AttributeContainer -

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class Master

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class Master

Returns:

int

initialize

protected void initialize(String newNumber,
                          String newName,
                          EPMAuthoringAppType authoringAppl,
                          EPMDocumentType documentType,
                          EPMDocSubType docSubType,
                          String CADName,
                          QuantityUnit defaultUnit)
                   throws WTException

Throws:

WTException

updateCADName

protected void updateCADName(String a_CADName)
                      throws WTException,
                             WTPropertyVetoException

Throws:

WTException

WTPropertyVetoException