wt.doc
Class WTDocument

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.RevisionControlled
          wt.doc.WTDocument

All Implemented Interfaces:

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

Direct Known Subclasses:

ProxyDocument

public class WTDocument

extends RevisionControlled

implements DocumentVersion, FormatContentHolder, Baselineable, Viewable, RequirementsManageable, Typed, WTContained, Templateable, Representable, OrganizationOwnedVersion, OneOffVersioned, Federatable, Releasable, Archiveable, Externalizable

The reference implementation of a DocumentVersion. It can be checked in and out, revised and holds content (one or more files). A document is visually recognized by an icon that represents the type of file content it contains. Each particular iteration and version of a document may have a different title, description and department. In order to provide for possible table partitioning of WTDocument data based on the type of document, the type field from WTDocumentMaster is duplicated in the WTDocument. Programmatic controls don't allow changing the document type once the document has been saved in the database. The type is constant for all versions. If WTDocument is extended to provide explicit java classes for new kinds of documents, then corresponding entries should be added DocumentTypeRB and the constructor methods implemented so that the java class carefully controls the docType property of the object .

Use the newWTDocument static factory method(s), not the WTDocument 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: true

See Also:

WTDocumentMaster, DocumentType, Serialized Form

Field Summary

private static String	CLASSNAME
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
private Vector	contentVector
private DepartmentList	department
static String	DEPARTMENT Label for the attribute.
private static int	DEPARTMENT_UPPER_LIMIT
private String	description
static String	DESCRIPTION Label for the attribute; Some text describing the document or noting important information that should be kept about a document.
private static int	DESCRIPTION_UPPER_LIMIT
static String	DOC_TYPE Label for the attribute.
private static int	DOC_TYPE_UPPER_LIMIT
private DocumentType	docType
static long	EXTERNALIZATION_VERSION_UID
private FederatableInfo	federatableInfo
private DataFormatReference	format
private boolean	hasContents
private Vector	httpVector
static String	NAME Label for the attribute.
static String	NUMBER Label for the attribute.
protected static long	OLD_FORMAT_VERSION_UID
private OneOffVersionInfo	oneOffVersionInfo
private HttpContentOperation	operation
private ContentItem	primary
static long	R51_EXTERNALIZATION_VERSION_UID
static long	R60_EXTERNALIZATION_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private TemplateInfo	template
private AttributeContainer	theAttributeContainer
private String	title
static String	TITLE Label for the attribute; The official title of a document.
private static int	TITLE_UPPER_LIMIT
private TypeDefinitionReference	typeDefinitionReference

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.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.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

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.type.Typed

TYPE_DEFINITION_REFERENCE

Fields inherited from interface wt.iba.value.IBAHolder

ATTRIBUTE_CONTAINER

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.enterprise.Templateable

TEMPLATE, TEMPLATED

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.vc.Versioned

VERSION_IDENTIFIER, VERSION_INFO

Fields inherited from interface wt.ufid.Federatable

FEDERATABLE_INFO

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

WTDocument()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
private void	departmentValidate(DepartmentList a_Department)
private void	descriptionValidate(String a_Description)
private void	docTypeValidate(DocumentType 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)
private void	formatValidate(DataFormatReference a_Format)
AttributeContainer	getAttributeContainer() Gets the object for the association that plays role: ATTRIBUTE_CONTAINER.
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.
DepartmentList	getDepartment() Gets the object for the association that plays role: DEPARTMENT.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
DocumentType	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.
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.
ContentItem	getPrimary() Gets the value of the attribute: PRIMARY.
TemplateInfo	getTemplate() Gets the object for the association that plays role: TEMPLATE.
String	getTitle() Gets the value of the attribute: TITLE.
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 number, String name, DocumentType type) Supports initialization, following construction of an instance.
protected void	initialize(WTDocumentMaster master) Supports initialization, following construction of an instance.
boolean	isHasContents() Gets the value of the attribute: HAS_CONTENTS.
boolean	isTemplated() Gets the value of the attribute: TEMPLATED.
private void	masterReferenceValidate(ObjectReference a_MasterReference)
static WTDocument	newWTDocument() For internal use.
static WTDocument	newWTDocument(String number, String name, DocumentType type) Constructs a General Document with the given name and number.
static WTDocument	newWTDocument(WTDocumentMaster master) Create a new Specification Document.
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(WTDocument 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	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	setDepartment(DepartmentList a_Department) Sets the object for the association that plays role: DEPARTMENT.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setDocType(DocumentType 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	setFormat(DataFormatReference a_Format) Sets the object for the association that plays role: FORMAT.
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	setMasterReference(ObjectReference a_MasterReference) Sets the value of the attribute: MASTER_REFERENCE.
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	setPrimary(ContentItem a_Primary) Sets the value of the attribute: PRIMARY.
void	setTemplate(TemplateInfo a_Template) Sets the object for the association that plays role: TEMPLATE.
void	setTitle(String a_Title) Sets the value of the attribute: TITLE.
void	setTypeDefinitionReference(TypeDefinitionReference a_TypeDefinitionReference) Sets the object for the association that plays role: TYPE_DEFINITION_REFERENCE.
private void	templateValidate(TemplateInfo a_Template)
private void	titleValidate(String a_Title)
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, initialize, 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.org.OrganizationOwnedVersion

getMaster, getMasterReference, setMaster

Methods inherited from interface wt.vc.Versioned

getVersionIdentifier, getVersionInfo, setVersionInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

TITLE

public static final String TITLE

Label for the attribute; The official title of a document.

Supported API: true

See Also:

Constant Field Values

TITLE_UPPER_LIMIT

private static int TITLE_UPPER_LIMIT

title

private String title

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute; Some text describing the document or noting important information that should be kept about a document.

Supported API: true

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

NAME

public static final String NAME

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

NUMBER

public static final String NUMBER

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

DEPARTMENT

public static final String DEPARTMENT

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

DEPARTMENT_UPPER_LIMIT

private static int DEPARTMENT_UPPER_LIMIT

department

private DepartmentList department

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 DocumentType docType

primary

private ContentItem primary

format

private DataFormatReference format

contentVector

private Vector contentVector

hasContents

private boolean hasContents

operation

private HttpContentOperation operation

httpVector

private Vector httpVector

typeDefinitionReference

private TypeDefinitionReference typeDefinitionReference

theAttributeContainer

private AttributeContainer theAttributeContainer

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

template

private TemplateInfo template

oneOffVersionInfo

private OneOffVersionInfo oneOffVersionInfo

federatableInfo

private FederatableInfo federatableInfo

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

R51_EXTERNALIZATION_VERSION_UID

public static final long R51_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

R60_EXTERNALIZATION_VERSION_UID

public static final long R60_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

WTDocument

public WTDocument()

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(WTDocument 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

getTitle

public String getTitle()

Gets the value of the attribute: TITLE. The official title of a document.

Supported API: true

Returns:

String

setTitle

public void setTitle(String a_Title)
              throws WTPropertyVetoException

Sets the value of the attribute: TITLE. The official title of a document.

Supported API: true

Parameters:

a_Title -

Throws:

WTPropertyVetoException

titleValidate

private void titleValidate(String a_Title)
                    throws WTPropertyVetoException

Parameters:

a_Title -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. Some text describing the document or noting important information that should be kept about a document.

Supported API: true

Returns:

String

setDescription

public void setDescription(String a_Description)
                    throws WTPropertyVetoException

Sets the value of the attribute: DESCRIPTION. Some text describing the document or noting important information that should be kept about a document.

Supported API: true

Parameters:

a_Description -

Throws:

WTPropertyVetoException

descriptionValidate

private void descriptionValidate(String a_Description)
                          throws WTPropertyVetoException

Parameters:

a_Description -

Throws:

WTPropertyVetoException

getName

public String getName()

Gets the value of the attribute: NAME.

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.

Supported API: true

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getNumber

public String getNumber()

Gets the value of the attribute: NUMBER.

Supported API: true

Returns:

String

setNumber

public void setNumber(String a_Number)
               throws WTPropertyVetoException

Sets the value of the attribute: NUMBER.

Supported API: true

Parameters:

a_Number -

Throws:

WTPropertyVetoException

getDepartment

public DepartmentList getDepartment()

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

Supported API: true

Returns:

DepartmentList

setDepartment

public void setDepartment(DepartmentList a_Department)
                   throws WTPropertyVetoException

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

Supported API: true

Parameters:

a_Department -

Throws:

WTPropertyVetoException

departmentValidate

private void departmentValidate(DepartmentList a_Department)
                         throws WTPropertyVetoException

Parameters:

a_Department -

Throws:

WTPropertyVetoException

setMasterReference

public void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: MASTER_REFERENCE.

Supported API: false

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

getDocType

public DocumentType getDocType()

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

Supported API: true

Returns:

DocumentType

setDocType

public void setDocType(DocumentType 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(DocumentType a_DocType)
                      throws WTPropertyVetoException

Parameters:

a_DocType -

Throws:

WTPropertyVetoException

newWTDocument

public static WTDocument newWTDocument()
                                throws WTException

For internal use. Do Not Use.

Supported API: true

Returns:

WTDocument

Throws:

WTException

newWTDocument

public static WTDocument newWTDocument(WTDocumentMaster master)
                                throws WTException

Create a new Specification Document. Must use the setIdentification to set name and number. Better to use the newSpecification(String name, String number) constructor instead.

Supported API: true

Parameters:

master -

Returns:

WTDocument

Throws:

WTException

initialize

protected void initialize(WTDocumentMaster master)
                   throws WTException

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

Supported API: true

Parameters:

master -

Throws:

WTException

newWTDocument

public static WTDocument newWTDocument(String number,
                                       String name,
                                       DocumentType type)
                                throws WTException

Constructs a General Document with the given name and number. Recommended constructor.

Supported API: true

Parameters:

number -

name -

type -

Returns:

WTDocument

Throws:

WTException

initialize

protected void initialize(String number,
                          String name,
                          DocumentType type)
                   throws WTException

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

Supported API: true

Parameters:

number -

name -

type -

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

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 -

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

isTemplated

public boolean isTemplated()

Gets the value of the attribute: TEMPLATED. a boolean attribute indicating whether template or not( derived attribute)

Supported API: false

Specified by:

isTemplated in interface Templateable

Returns:

boolean

getTemplate

public TemplateInfo getTemplate()

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

Supported API: false

Specified by:

getTemplate in interface Templateable

Returns:

TemplateInfo

setTemplate

public void setTemplate(TemplateInfo a_Template)
                 throws WTPropertyVetoException

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

Supported API: false

Specified by:

setTemplate in interface Templateable

Parameters:

a_Template -

Throws:

WTPropertyVetoException

templateValidate

private void templateValidate(TemplateInfo a_Template)
                       throws WTPropertyVetoException

Parameters:

a_Template -

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

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

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

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Description copied from interface: Persistable

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Overrides:

checkAttributes in class WTObject

Throws:

InvalidAttributeException