wt.epm
Class EPMDocument

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.RevisionControlled
          wt.epm.EPMDocument

All Implemented Interfaces:

_DepthLock000, _DepthLock001, _DepthLock002, _DepthLock003, _DepthLock004, _DepthLock005, _DepthLock006, _DepthLock007, AccessControlled, AccessControlList, AdHocControlled, Archiveable, Baselineable, BuildSource, BusinessInformation, CabinetBased, Changeable2, ChangeableIfc, ContentHolder, DisplayIdentification, Document, DocumentVersion, DomainAdministered, EffectivityHolder, EffectivityManageable, EffManagedVersion, ElectronicallySignable, EPMFeatureContainer, EPMObject, EPMParameterContainer, EPMSupportingDataHolder, Externalizable, Federatable, Foldered, FolderEntry, FolderServiceManaged, FormatContentHolder, GraphicallyRepresentable, IBAHolder, Indexable, Iterated, IteratedFoldered, IteratedLifeCycleManaged, IteratedSubjectOfForum, IteratedSubjectOfNotebook, LifeCycleManaged, Lockable, NetFactor, Notifiable, ObjectMappable, OneOffVersioned, OrganizationOwned, OrganizationOwnedVersion, Ownable, Persistable, Promotable, RecentlyVisited, Releasable, RemotelyLinkable, Representable, RepresentablesAndMasters, RepresentationContributor, Serializable, SubjectOfForum, SubjectOfNotebook, TeamManaged, Trackable, Typed, UsesOccurrenceContext, Versionable, Versioned, Workable, WorkspaceTrackable, WTContained

public class EPMDocument

extends RevisionControlled

implements EPMSupportingDataHolder, DocumentVersion, FormatContentHolder, Baselineable, EPMObject, BuildSource, EffectivityManageable, GraphicallyRepresentable, Federatable, UsesOccurrenceContext, WTContained, OrganizationOwnedVersion, OneOffVersioned, Typed, EPMFeatureContainer, EPMParameterContainer, WorkspaceTrackable, Releasable, Archiveable, Externalizable

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:

Serialized Form

Field Summary

static String	AUTHORING_APP_VERSION Label for the attribute.
static String	AUTHORING_APP_VERSION_REFERENCE Label for the attribute.
static String	AUTHORING_APPLICATION Label for the attribute; Indicates that the named application authored the object.
private EPMAuthAppVersionRef	authoringAppVersionReference
static String	BOX_EXTENTS Label for the attribute.
private EPMBoxExtents	boxExtents
static String	CADNAME Label for the attribute; The CAD name of the document.
private static String	CLASSNAME
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
private Vector	contentVector
static String	DB_KEY_SIZE Label for the attribute.
private int	dbKeySize
static String	DEFAULT_UNIT Label for the attribute; The default unit of measure for the document.
private String	description
static String	DESCRIPTION Label for the attribute; A user-specified description field.
private static int	DESCRIPTION_UPPER_LIMIT
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
private Vector	effVector
static String	EXTENTS_VALID Label for the attribute; Indicator of the validity of the current EPMBoxExtents.
private boolean	extentsValid
static long	EXTERNALIZATION_VERSION_UID
static String	FAMILY_TABLE_STATUS Label for the attribute.
private int	familyTableStatus
private FederatableInfo	federatableInfo
private DataFormatReference	format
static int	FTS_FAMILY_TABLE
static int	FTS_GENERIC
static int	FTS_INSTANCE
static int	FTS_STANDALONE
static String	GENERIC Label for the attribute; True if EPMDocument is family table generic.
private boolean	hasContents
private Vector	httpVector
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.
private boolean	missingDependents
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.
protected static long	OLD_FORMAT_VERSION_UID
private OneOffVersionInfo	oneOffVersionInfo
private HttpContentOperation	operation
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.
private boolean	placeHolder
private ContentItem	primary
static long	R70_EXTERNALIZATION_VERSION_UID
static String	REFERENCE_CONTROL Label for the attribute.
private EPMCADReferenceControl	referenceControl
private static String	RESOURCE
static String	REVISION_NUMBER Label for the attribute.
private int	revisionNumber
(package private) static long	serialVersionUID
private AttributeContainer	theAttributeContainer
static String	TOP_GENERIC Label for the attribute; True if EPMDocument is family table top generic.
private TypeDefinitionReference	typeDefinitionReference
private boolean	verified
static String	VERIFIED Label for the attribute.

Fields inherited from class wt.enterprise.RevisionControlled

MASTER, VERSION_DISPLAY_IDENTIFIER, VERSION_DISPLAY_IDENTITY, VERSION_DISPLAY_TYPE

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.content.FormatContentHolder

FORMAT, FORMAT_NAME, PRIMARY

Fields inherited from interface wt.content.ContentHolder

CONTENT_VECTOR, HAS_CONTENTS, HTTP_VECTOR, OPERATION

Fields 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_NAME

Fields inherited from interface wt.epm.EPMObject

UNSPECIFIED

Fields inherited from interface wt.eff.EffManagedVersion

EFF_VECTOR

Fields inherited from interface wt.vc.Versioned

VERSION_IDENTIFIER, VERSION_INFO

Fields inherited from interface wt.ufid.Federatable

FEDERATABLE_INFO

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.org.OrganizationOwnedVersion

MASTER, MASTER_REFERENCE, ORGANIZATION_REFERENCE

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION, ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Fields inherited from interface wt.vc.OneOffVersioned

ONE_OFF_VERSION_IDENTIFIER, ONE_OFF_VERSION_INFO

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.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.vc.wip.Workable

CHECKOUT_INFO

Fields inherited from interface wt.locks.Lockable

LOCK, LOCK_DATE, LOCK_NOTE, LOCKED, LOCKER, LOCKER_EMAIL, LOCKER_FULL_NAME, LOCKER_NAME

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.folder.Foldered

CABINET, CABINET_NAME, FOLDERING_INFO

Fields inherited from interface wt.folder.CabinetBased

CABINET_REFERENCE, FOLDER_PATH, LOCATION

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.index.Indexable

INDEXER_SET

Fields inherited from interface wt.lifecycle.LifeCycleManaged

LIFE_CYCLE_AT_GATE, LIFE_CYCLE_BASIC, LIFE_CYCLE_NAME, LIFE_CYCLE_STATE, LIFE_CYCLE_TEMPLATE, STATE

Fields inherited from interface wt.access.AdHocControlled

ENTRY_SET

Fields inherited from interface wt.team.TeamManaged

TEAM_ID, TEAM_IDENTITY, TEAM_NAME, TEAM_TEMPLATE_ID, TEAM_TEMPLATE_IDENTITY, TEAM_TEMPLATE_NAME

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

EPMDocument()

Method Summary

private void	authoringAppVersionReferenceValidate(EPMAuthAppVersionRef a_AuthoringAppVersionReference)
void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	checkAuthoringApplication(EPMAuthAppVersionRef a_AuthoringAppVersionReference)
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
private void	descriptionValidate(String a_Description)
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)
private void	formatValidate(DataFormatReference a_Format)
AttributeContainer	getAttributeContainer() Gets the object for the association that plays role: ATTRIBUTE_CONTAINER.
EPMAuthoringAppType	getAuthoringApplication() Gets the value of the attribute: AUTHORING_APPLICATION.
EPMAuthoringAppVersion	getAuthoringAppVersion() Gets the object for the association that plays role: AUTHORING_APP_VERSION.
EPMAuthAppVersionRef	getAuthoringAppVersionReference() Gets the value of the attribute: AUTHORING_APP_VERSION_REFERENCE.
EPMBoxExtents	getBoxExtents() Gets the object for the association that plays role: BOX_EXTENTS.
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.
Vector	getContentVector() Gets the value of the attribute: CONTENT_VECTOR.
int	getDbKeySize() Gets the value of the attribute: DB_KEY_SIZE.
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.
Vector	getEffVector() Gets the object for the association that plays role: EFF_VECTOR.
int	getFamilyTableStatus() Gets the value of the attribute: FAMILY_TABLE_STATUS.
Map	getFeatureValues() Supported API: false
FederatableInfo	getFederatableInfo() Gets the object for the association that plays role: FEDERATABLE_INFO.
DataFormatReference	getFormat() Gets the object for the association that plays role: FORMAT.
String	getFormatName() Gets the value of the attribute: FORMAT_NAME.
Vector	getHttpVector() Gets the value of the attribute: HTTP_VECTOR.
String	getName() Gets the value of the attribute: NAME.
String	getNumber() Gets the value of the attribute: NUMBER.
OneOffVersionIdentifier	getOneOffVersionIdentifier() Gets the value of the attribute: ONE_OFF_VERSION_IDENTIFIER.
OneOffVersionInfo	getOneOffVersionInfo() Gets the object for the association that plays role: ONE_OFF_VERSION_INFO.
HttpContentOperation	getOperation() Gets the value of the attribute: OPERATION.
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.
Map	getParameterValues() Supported API: false
ContentItem	getPrimary() Gets the value of the attribute: PRIMARY.
EPMCADReferenceControl	getReferenceControl() Gets the object for the association that plays role: REFERENCE_CONTROL.
int	getRevisionNumber() Gets the value of the attribute: REVISION_NUMBER.
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() Initializes objects created by new-factory methods.
protected void	initialize(EPMDocument document) Supports initialization, following construction of an instance.
protected void	initialize(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType) Deprecated.
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	isHasContents() Gets the value of the attribute: HAS_CONTENTS.
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.
boolean	isVerified() Gets the value of the attribute: VERIFIED.
private void	masterReferenceValidate(ObjectReference a_MasterReference)
private void	missingDependentsValidate(boolean a_MissingDependents)
static EPMDocument	newEPMDocument() For internal use.
static EPMDocument	newEPMDocument(EPMDocument document) For internal use only Supported API: false
static EPMDocument	newEPMDocument(String number, String name, EPMAuthoringAppType authoringApp, EPMDocumentType docType) Deprecated. use newEPMDocument(String, String, EPMAuthoringAppType, EPMDocumentType, String) as CAD name is required.
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
private void	placeHolderValidate(boolean a_PlaceHolder)
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(EPMDocument 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	setAuthoringAppVersion(EPMAuthoringAppVersion a_AuthoringAppVersion) Sets the object for the association that plays role: AUTHORING_APP_VERSION.
void	setAuthoringAppVersionReference(EPMAuthAppVersionRef a_AuthoringAppVersionReference) Sets the value of the attribute: AUTHORING_APP_VERSION_REFERENCE.
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	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	setContentVector(Vector a_ContentVector) Sets the value of the attribute: CONTENT_VECTOR.
void	setDbKeySize(int a_DbKeySize) Sets the value of the attribute: DB_KEY_SIZE.
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	setEffVector(Vector a_EffVector) Sets the object for the association that plays role: EFF_VECTOR.
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	setFeatureValues(Map a_FeatureValues)
void	setFederatableInfo(FederatableInfo a_FederatableInfo) Sets the object for the association that plays role: FEDERATABLE_INFO.
void	setFormat(DataFormatReference a_Format) Sets the object for the association that plays role: FORMAT.
void	setGeneric(boolean a_Generic) Sets the value of the attribute: GENERIC.
void	setHasContents(boolean a_HasContents) Sets the value of the attribute: HAS_CONTENTS.
void	setHttpVector(Vector a_HttpVector) Sets the value of the attribute: HTTP_VECTOR.
void	setInstance(boolean a_Instance) Sets the value of the attribute: INSTANCE.
void	setMasterReference(ObjectReference a_MasterReference) Sets the value of the attribute: MASTER_REFERENCE.
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	setOneOffVersionInfo(OneOffVersionInfo a_OneOffVersionInfo) Sets the object for the association that plays role: ONE_OFF_VERSION_INFO.
void	setOperation(HttpContentOperation a_Operation) Sets the value of the attribute: OPERATION.
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	setParameterValues(Map a_ParameterValues)
void	setPlaceHolder(boolean a_PlaceHolder) Sets the value of the attribute: PLACE_HOLDER.
void	setPrimary(ContentItem a_Primary) Sets the value of the attribute: PRIMARY.
void	setReferenceControl(EPMCADReferenceControl a_ReferenceControl) Sets the object for the association that plays role: REFERENCE_CONTROL.
void	setRevisionNumber(int a_RevisionNumber) Sets the value of the attribute: REVISION_NUMBER.
void	setTopGeneric(boolean a_TopGeneric) Sets the value of the attribute: TOP_GENERIC.
void	setTypeDefinitionReference(TypeDefinitionReference a_TypeDefinitionReference) Sets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.
void	setVerified(boolean a_Verified) Sets the value of the attribute: VERIFIED.
private void	typeDefinitionReferenceValidate(TypeDefinitionReference a_TypeDefinitionReference)
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.RevisionControlled

getBranchIdentifier, getBusinessType, getCabinet, getCabinetName, getCabinetReference, getCheckoutInfo, getControlBranch, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getDomainRef, getEntrySet, getEventSet, getFolderingInfo, getFolderPath, getIdentity, getIndexerSet, getIterationDisplayIdentifier, getIterationIdentifier, getIterationInfo, getIterationNote, getLifeCycleName, getLifeCycleState, getLifeCycleTemplate, getLocation, getLock, getLockDate, getLocker, getLockerEMail, getLockerFullName, getLockerName, getLockNote, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, getOwnership, getState, getTeamId, getTeamIdentity, getTeamName, getTeamTemplateId, getTeamTemplateIdentity, getTeamTemplateName, getVersionDisplayIdentifier, getVersionDisplayIdentity, getVersionDisplayType, getVersionIdentifier, getVersionInfo, isInheritedDomain, isLatestIteration, isLifeCycleAtGate, isLifeCycleBasic, isLocked, readVersion, setCheckoutInfo, setControlBranch, setDomainRef, setEntrySet, setEventSet, setFolderingInfo, setIndexerSet, setInheritedDomain, setIterationInfo, setLock, setMaster, setOwnership, setState, setTeamId, setTeamTemplateId, setVersionInfo

Methods inherited from class wt.fc.WTObject

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.fc.Persistable

getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Methods 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

Methods inherited from interface wt.vc.Versioned

getVersionIdentifier, getVersionInfo, setVersionInfo

Methods inherited from interface wt.org.OrganizationOwnedVersion

getMaster, getMasterReference, setMaster

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

Supported API: true

See Also:

Constant Field Values

NAME

public static final String NAME

Label for the attribute; The name of the document.

Supported API: true

See Also:

Constant Field Values

EXTENTS_VALID

public static final String EXTENTS_VALID

Label for the attribute; Indicator of the validity of the current EPMBoxExtents. This value will allow the user to postpone recalculation of the extents after a modification of the CAD model.

Supported API: true

See Also:

Constant Field Values

extentsValid

private boolean extentsValid

CADNAME

public static final String CADNAME

Label for the attribute; The CAD name of the document.

Supported API: true

See Also:

Constant Field Values

DOC_TYPE

public static final String DOC_TYPE

Label for the attribute; The type of the document

Supported API: true

See Also:

Constant Field Values

DOC_SUB_TYPE

public static final String DOC_SUB_TYPE

Label for the attribute; The subtype of the document

Supported API: true

See Also:

Constant Field Values

MISSING_DEPENDENTS

public static final String MISSING_DEPENDENTS

Label for the attribute; Flag to indicate if some of the dependencies of the CADModel are missing. Those missing dependents are either ignored or not available when the data is published.

Supported API: true

See Also:

Constant Field Values

missingDependents

private boolean missingDependents

PLACE_HOLDER

public static final String PLACE_HOLDER

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

See Also:

Constant Field Values

placeHolder

private boolean placeHolder

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute; A user-specified description field.

Supported API: true

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

OWNER_APPLICATION

public static final String OWNER_APPLICATION

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

See Also:

Constant Field Values

AUTHORING_APPLICATION

public static final String AUTHORING_APPLICATION

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

See Also:

Constant Field Values

DB_KEY_SIZE

public static final String DB_KEY_SIZE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

dbKeySize

private int dbKeySize

VERIFIED

public static final String VERIFIED

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

verified

private boolean verified

REVISION_NUMBER

public static final String REVISION_NUMBER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

revisionNumber

private int revisionNumber

FAMILY_TABLE_STATUS

public static final String FAMILY_TABLE_STATUS

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

familyTableStatus

private int familyTableStatus

GENERIC

public static final String GENERIC

Label for the attribute; True if EPMDocument is family table generic.

Supported API: true

See Also:

Constant Field Values

INSTANCE

public static final String INSTANCE

Label for the attribute; True if EPMDocument is family table instance.

Supported API: true

See Also:

Constant Field Values

TOP_GENERIC

public static final String TOP_GENERIC

Label for the attribute; True if EPMDocument is family table top generic.

Supported API: true

See Also:

Constant Field Values

DEFAULT_UNIT

public static final String DEFAULT_UNIT

Label for the attribute; The default unit of measure for the document.

Supported API: true

See Also:

Constant Field Values

BOX_EXTENTS

public static final String BOX_EXTENTS

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

boxExtents

private EPMBoxExtents boxExtents

AUTHORING_APP_VERSION

public static final String AUTHORING_APP_VERSION

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

AUTHORING_APP_VERSION_REFERENCE

public static final String AUTHORING_APP_VERSION_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

authoringAppVersionReference

private EPMAuthAppVersionRef authoringAppVersionReference

REFERENCE_CONTROL

public static final String REFERENCE_CONTROL

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

referenceControl

private EPMCADReferenceControl referenceControl

primary

private ContentItem primary

format

private DataFormatReference format

contentVector

private Vector contentVector

hasContents

private boolean hasContents

operation

private HttpContentOperation operation

httpVector

private Vector httpVector

effVector

private Vector effVector

federatableInfo

private FederatableInfo federatableInfo

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

oneOffVersionInfo

private OneOffVersionInfo oneOffVersionInfo

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

FTS_STANDALONE

public static final int FTS_STANDALONE

See Also:

Constant Field Values

FTS_INSTANCE

public static final int FTS_INSTANCE

See Also:

Constant Field Values

FTS_GENERIC

public static final int FTS_GENERIC

See Also:

Constant Field Values

FTS_FAMILY_TABLE

public static final int FTS_FAMILY_TABLE

See Also:

Constant Field Values

R70_EXTERNALIZATION_VERSION_UID

public static final long R70_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

EPMDocument

public EPMDocument()

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 RevisionControlled

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 RevisionControlled

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(EPMDocument 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 RevisionControlled

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 RevisionControlled

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

Supported API: true

Parameters:

a_Number -

Throws:

WTPropertyVetoException

getName

public String getName()

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

Supported API: true

Specified by:

getName in interface CabinetBased

Overrides:

getName in class RevisionControlled

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

isExtentsValid

public boolean isExtentsValid()

Gets the value of the attribute: EXTENTS_VALID. Indicator of the validity of the current EPMBoxExtents. This value will allow the user to postpone recalculation of the extents after a modification of the CAD model.

Supported API: true

Returns:

boolean

setExtentsValid

public void setExtentsValid(boolean a_ExtentsValid)
                     throws WTPropertyVetoException

Sets the value of the attribute: EXTENTS_VALID. Indicator of the validity of the current EPMBoxExtents. This value will allow the user to postpone recalculation of the extents after a modification of the CAD model.

Supported API: true

Parameters:

a_ExtentsValid -

Throws:

WTPropertyVetoException

getCADName

public String getCADName()

Gets the value of the attribute: CADNAME. The CAD name of the document.

Supported API: true

Returns:

String

setCADName

public void setCADName(String a_CADName)
                throws WTPropertyVetoException

Sets the value of the attribute: CADNAME. The CAD name of the document.

Supported API: true

Parameters:

a_CADName -

Throws:

WTPropertyVetoException

getDocType

public EPMDocumentType getDocType()

Gets the value of the attribute: DOC_TYPE. The type of the document

Supported API: true

Returns:

EPMDocumentType

setDocType

public void setDocType(EPMDocumentType a_DocType)
                throws WTPropertyVetoException

Sets the value of the attribute: DOC_TYPE. The type of the document

Supported API: true

Parameters:

a_DocType -

Throws:

WTPropertyVetoException

getDocSubType

public EPMDocSubType getDocSubType()

Gets the value of the attribute: DOC_SUB_TYPE. The subtype of the document

Supported API: true

Returns:

EPMDocSubType

setDocSubType

public void setDocSubType(EPMDocSubType a_DocSubType)
                   throws WTPropertyVetoException

Sets the value of the attribute: DOC_SUB_TYPE. The subtype of the document

Supported API: true

Parameters:

a_DocSubType -

Throws:

WTPropertyVetoException

isMissingDependents

public boolean isMissingDependents()

Gets the value of the attribute: MISSING_DEPENDENTS. Flag to indicate if some of the dependencies of the CADModel are missing. Those missing dependents are either ignored or not available when the data is published.

Supported API: true

Returns:

boolean

setMissingDependents

public void setMissingDependents(boolean a_MissingDependents)
                          throws WTPropertyVetoException

Sets the value of the attribute: MISSING_DEPENDENTS. Flag to indicate if some of the dependencies of the CADModel are missing. Those missing dependents are either ignored or not available when the data is published.

Supported API: true

Parameters:

a_MissingDependents -

Throws:

WTPropertyVetoException

missingDependentsValidate

private void missingDependentsValidate(boolean a_MissingDependents)
                                throws WTPropertyVetoException

Parameters:

a_MissingDependents -

Throws:

WTPropertyVetoException

isPlaceHolder

public boolean isPlaceHolder()

Gets 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

Returns:

boolean

setPlaceHolder

public void setPlaceHolder(boolean a_PlaceHolder)
                    throws WTPropertyVetoException

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

Parameters:

a_PlaceHolder -

Throws:

WTPropertyVetoException

placeHolderValidate

private void placeHolderValidate(boolean a_PlaceHolder)
                          throws WTPropertyVetoException

Parameters:

a_PlaceHolder -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. A user-specified description field.

Supported API: true

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. A user-specified description field.

Supported API: true

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getOwnerApplication

public EPMApplicationType 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:

getOwnerApplication in interface EPMObject

Returns:

EPMApplicationType

getAuthoringApplication

public EPMAuthoringAppType 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:

getAuthoringApplication in interface EPMObject

Returns:

EPMAuthoringAppType

getDbKeySize

public int getDbKeySize()

Gets the value of the attribute: DB_KEY_SIZE.

Supported API: false

Returns:

int

setDbKeySize

public void setDbKeySize(int a_DbKeySize)
                  throws WTPropertyVetoException

Sets the value of the attribute: DB_KEY_SIZE.

Supported API: false

Parameters:

a_DbKeySize -

Throws:

WTPropertyVetoException

isVerified

public boolean isVerified()

Gets the value of the attribute: VERIFIED.

Supported API: false

Returns:

boolean

setVerified

public void setVerified(boolean a_Verified)
                 throws WTPropertyVetoException

Sets the value of the attribute: VERIFIED.

Supported API: false

Parameters:

a_Verified -

Throws:

WTPropertyVetoException

getRevisionNumber

public int getRevisionNumber()

Gets the value of the attribute: REVISION_NUMBER.

Supported API: false

Returns:

int

setRevisionNumber

public void setRevisionNumber(int a_RevisionNumber)
                       throws WTPropertyVetoException

Sets the value of the attribute: REVISION_NUMBER.

Supported API: false

Parameters:

a_RevisionNumber -

Throws:

WTPropertyVetoException

getFamilyTableStatus

public int getFamilyTableStatus()

Gets the value of the attribute: FAMILY_TABLE_STATUS.

Supported API: true

Returns:

int

setFamilyTableStatus

public void setFamilyTableStatus(int a_FamilyTableStatus)
                          throws WTPropertyVetoException

Sets the value of the attribute: FAMILY_TABLE_STATUS.

Supported API: true

Parameters:

a_FamilyTableStatus -

Throws:

WTPropertyVetoException

isGeneric

public boolean isGeneric()

Gets the value of the attribute: GENERIC. True if EPMDocument is family table generic.

Supported API: true

Returns:

boolean

setGeneric

public void setGeneric(boolean a_Generic)
                throws WTPropertyVetoException

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

public void setInstance(boolean a_Instance)
                 throws WTPropertyVetoException

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

public void setTopGeneric(boolean a_TopGeneric)
                   throws WTPropertyVetoException

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

public QuantityUnit getDefaultUnit()

Gets the value of the attribute: DEFAULT_UNIT. The default unit of measure for the document.

Supported API: true

Returns:

QuantityUnit

setMasterReference

public void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: MASTER_REFERENCE.

Supported API: true

Specified by:

setMasterReference in interface Iterated

Overrides:

setMasterReference in class RevisionControlled

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

See Also:

Mastered

masterReferenceValidate

private void masterReferenceValidate(ObjectReference a_MasterReference)
                              throws WTPropertyVetoException

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

getBoxExtents

public EPMBoxExtents getBoxExtents()

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

Supported API: true

Returns:

EPMBoxExtents

setBoxExtents

public void setBoxExtents(EPMBoxExtents a_BoxExtents)

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

Supported API: true

Parameters:

a_BoxExtents -

getAuthoringAppVersion

public EPMAuthoringAppVersion getAuthoringAppVersion()

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

Supported API: false

Returns:

EPMAuthoringAppVersion

setAuthoringAppVersion

public void setAuthoringAppVersion(EPMAuthoringAppVersion a_AuthoringAppVersion)
                            throws WTPropertyVetoException,
                                   WTException

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

Supported API: false

Parameters:

a_AuthoringAppVersion -

Throws:

WTPropertyVetoException

WTException

getAuthoringAppVersionReference

public EPMAuthAppVersionRef getAuthoringAppVersionReference()

Gets the value of the attribute: AUTHORING_APP_VERSION_REFERENCE.

Supported API: false

Returns:

EPMAuthAppVersionRef

setAuthoringAppVersionReference

public void setAuthoringAppVersionReference(EPMAuthAppVersionRef a_AuthoringAppVersionReference)
                                     throws WTPropertyVetoException

Sets the value of the attribute: AUTHORING_APP_VERSION_REFERENCE.

Supported API: false

Parameters:

a_AuthoringAppVersionReference -

Throws:

WTPropertyVetoException

authoringAppVersionReferenceValidate

private void authoringAppVersionReferenceValidate(EPMAuthAppVersionRef a_AuthoringAppVersionReference)
                                           throws WTPropertyVetoException

Parameters:

a_AuthoringAppVersionReference -

Throws:

WTPropertyVetoException

getReferenceControl

public EPMCADReferenceControl getReferenceControl()

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

Supported API: false

Returns:

EPMCADReferenceControl

setReferenceControl

public void setReferenceControl(EPMCADReferenceControl a_ReferenceControl)
                         throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_ReferenceControl -

Throws:

WTPropertyVetoException

newEPMDocument

public static EPMDocument newEPMDocument(String number,
                                         String name,
                                         EPMAuthoringAppType authoringApp,
                                         EPMDocumentType docType)
                                  throws WTException

Deprecated. use newEPMDocument(String, String, EPMAuthoringAppType, EPMDocumentType, String) as CAD name is required.

Supported API: false

Parameters:

number -

name -

authoringApp -

docType -

Returns:

EPMDocument

Throws:

WTException

initialize

protected void initialize(String number,
                          String name,
                          EPMAuthoringAppType authoringApp,
                          EPMDocumentType docType)
                   throws WTException

Deprecated.

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

number -

name -

authoringApp -

docType -

Throws:

WTException

newEPMDocument

public static EPMDocument newEPMDocument(EPMDocument document)
                                  throws WTException

For internal use only

Supported API: false

Parameters:

document -

Returns:

EPMDocument

Throws:

WTException

initialize

protected void initialize(EPMDocument document)
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Parameters:

document -

Throws:

WTException

newEPMDocument

public static EPMDocument newEPMDocument()
                                  throws WTException

For internal use. Do Not Use.

Supported API: true

Returns:

EPMDocument

Throws:

WTException

newEPMDocument

public static EPMDocument newEPMDocument(String number,
                                         String name,
                                         EPMAuthoringAppType authoringApp,
                                         EPMDocumentType docType,
                                         String CADName)
                                  throws WTException

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

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

newEPMDocument

public static EPMDocument newEPMDocument(String number,
                                         String name,
                                         EPMAuthoringAppType authoringApp,
                                         EPMDocumentType docType,
                                         String CADName,
                                         QuantityUnit defaultUnit)
                                  throws WTException

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

getFormatName

public String getFormatName()

Gets the value of the attribute: FORMAT_NAME.

Supported API: false

Specified by:

getFormatName in interface FormatContentHolder

Returns:

String

getPrimary

public ContentItem getPrimary()

Gets the value of the attribute: PRIMARY. This is a non-persistent ContentItem for FormatContentHolders that is used to pass the primary content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getPrimary in interface FormatContentHolder

Returns:

ContentItem

setPrimary

public void setPrimary(ContentItem a_Primary)
                throws WTPropertyVetoException

Sets the value of the attribute: PRIMARY. This is a non-persistent ContentItem for FormatContentHolders that is used to pass the primary content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setPrimary in interface FormatContentHolder

Parameters:

a_Primary -

Throws:

WTPropertyVetoException

getFormat

public DataFormatReference getFormat()

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

Supported API: false

Specified by:

getFormat in interface FormatContentHolder

Returns:

DataFormatReference

setFormat

public void setFormat(DataFormatReference a_Format)
               throws WTPropertyVetoException

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

Supported API: false

Specified by:

setFormat in interface FormatContentHolder

Parameters:

a_Format -

Throws:

WTPropertyVetoException

formatValidate

private void formatValidate(DataFormatReference a_Format)
                     throws WTPropertyVetoException

Parameters:

a_Format -

Throws:

WTPropertyVetoException

getContentVector

public Vector getContentVector()

Gets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getContentVector in interface ContentHolder

Returns:

Vector

setContentVector

public void setContentVector(Vector a_ContentVector)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTENT_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setContentVector in interface ContentHolder

Parameters:

a_ContentVector -

Throws:

WTPropertyVetoException

isHasContents

public boolean isHasContents()

Gets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

isHasContents in interface ContentHolder

Returns:

boolean

setHasContents

public void setHasContents(boolean a_HasContents)
                    throws WTPropertyVetoException

Sets the value of the attribute: HAS_CONTENTS. This is a non-persistent variable that is used to pass information from server to client. Should not be directly accessed by the client

Supported API: false

Specified by:

setHasContents in interface ContentHolder

Parameters:

a_HasContents -

Throws:

WTPropertyVetoException

getOperation

public HttpContentOperation getOperation()

Gets the value of the attribute: OPERATION.

Supported API: false

Specified by:

getOperation in interface ContentHolder

Returns:

HttpContentOperation

setOperation

public void setOperation(HttpContentOperation a_Operation)
                  throws WTPropertyVetoException

Sets the value of the attribute: OPERATION.

Supported API: false

Specified by:

setOperation in interface ContentHolder

Parameters:

a_Operation -

Throws:

WTPropertyVetoException

getHttpVector

public Vector getHttpVector()

Gets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

getHttpVector in interface ContentHolder

Returns:

Vector

setHttpVector

public void setHttpVector(Vector a_HttpVector)
                   throws WTPropertyVetoException

Sets the value of the attribute: HTTP_VECTOR. This is a non-persistent vector that is used to pass content from server to client. Should not be directly accessed by the client.

Supported API: false

Specified by:

setHttpVector in interface ContentHolder

Parameters:

a_HttpVector -

Throws:

WTPropertyVetoException

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

In particular, this must check that the modifications to the object were made by an approved application.

Supported API: true

Specified by:

checkAttributes in interface Persistable

Overrides:

checkAttributes in class WTObject

Throws:

InvalidAttributeException

getEffVector

public Vector getEffVector()

Gets the object for the association that plays role: EFF_VECTOR. Add the following code to setEffVector to facilitate the synchronization:

If the effVector was not null coming in, the EffGroups will logically become orphaned after the vector is replaced. We can't, however, set the EffGroup's target to null (it's required). So, we won't do anything here; rather, getTarget in EffGroup will return null if it's no longer synchronized. Unfortunately, we can't synchronize a call to addElement. Don't call addElement -- instead setTarget on the EffGroup side; this will cause the group to be added to the vector.

effVector = a_EffVector;

// synchronization for bidirectional association for (int i = 0; effVector != null && i < effVector.size(); i++) ((EffGroup) effVector.elementAt(i)).setTarget(this);

Supported API: true

Specified by:

getEffVector in interface EffManagedVersion

Returns:

Vector

setEffVector

public void setEffVector(Vector a_EffVector)
                  throws WTPropertyVetoException

Sets the object for the association that plays role: EFF_VECTOR. Add the following code to setEffVector to facilitate the synchronization:

If the effVector was not null coming in, the EffGroups will logically become orphaned after the vector is replaced. We can't, however, set the EffGroup's target to null (it's required). So, we won't do anything here; rather, getTarget in EffGroup will return null if it's no longer synchronized. Unfortunately, we can't synchronize a call to addElement. Don't call addElement -- instead setTarget on the EffGroup side; this will cause the group to be added to the vector.

effVector = a_EffVector;

// synchronization for bidirectional association for (int i = 0; effVector != null && i < effVector.size(); i++) ((EffGroup) effVector.elementAt(i)).setTarget(this);

Supported API: true

Specified by:

setEffVector in interface EffManagedVersion

Parameters:

a_EffVector -

Throws:

WTPropertyVetoException

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

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

getContainer

public WTContainer getContainer()

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

Supported API: false

Specified by:

getContainer in interface WTContained

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 WTContained

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 WTContained

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 WTContained

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

getOrganizationReference

public WTPrincipalReference getOrganizationReference()

Gets the value of the attribute: ORGANIZATION_REFERENCE.

Supported API: false

Specified by:

getOrganizationReference in interface OrganizationOwnedVersion

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 OrganizationOwnedVersion

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

getOneOffVersionIdentifier

public OneOffVersionIdentifier getOneOffVersionIdentifier()

Gets the value of the attribute: ONE_OFF_VERSION_IDENTIFIER. Derived attribute for displaying the one-off version identifier in query results.

Supported API: false

Specified by:

getOneOffVersionIdentifier in interface OneOffVersioned

Returns:

OneOffVersionIdentifier

getOneOffVersionInfo

public OneOffVersionInfo getOneOffVersionInfo()

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

Supported API: false

Specified by:

getOneOffVersionInfo in interface OneOffVersioned

Returns:

OneOffVersionInfo

setOneOffVersionInfo

public void setOneOffVersionInfo(OneOffVersionInfo a_OneOffVersionInfo)
                          throws WTPropertyVetoException

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

Supported API: false

Specified by:

setOneOffVersionInfo in interface OneOffVersioned

Parameters:

a_OneOffVersionInfo -

Throws:

WTPropertyVetoException

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 -

getFeatureValues

public Map getFeatureValues()
                     throws WTException

Supported API: false

Specified by:

getFeatureValues in interface EPMFeatureContainer

Returns:

Map

Throws:

WTException

getParameterValues

public Map getParameterValues()
                       throws WTException

Supported API: false

Specified by:

getParameterValues in interface EPMParameterContainer

Returns:

Map

Throws:

WTException

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 RevisionControlled

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 RevisionControlled

Returns:

int

initialize

protected void initialize()
                   throws WTException

Description copied from class: RevisionControlled

Initializes objects created by new-factory methods.

Supported API: false

Overrides:

initialize in class RevisionControlled

Throws:

WTException

checkAuthoringApplication

private void checkAuthoringApplication(EPMAuthAppVersionRef a_AuthoringAppVersionReference)
                                throws WTPropertyVetoException

Throws:

WTPropertyVetoException

setFeatureValues

public void setFeatureValues(Map a_FeatureValues)
                      throws WTPropertyVetoException

Specified by:

setFeatureValues in interface EPMFeatureContainer

Throws:

WTPropertyVetoException

setParameterValues

public void setParameterValues(Map a_ParameterValues)
                        throws WTPropertyVetoException

Specified by:

setParameterValues in interface EPMParameterContainer

Throws:

WTPropertyVetoException