wt.doc
Class WTDocument

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

All Implemented Interfaces:

Externalizable, Serializable, AccessControlled, wt.access.AccessControlList, wt.access.AdHocControlled, IdentityAccessControlled, wt.access.PolicyAccessControlled, wt.access.SecurityLabeled, wt.admin.DomainAdministered, Changeable2, ChangeableIfc, ContentHolder, FormatContentHolder, Document, DocumentVersion, wt.enterprise.Templateable, Releasable, wt.fc.archive.Archiveable, wt.fc.archive.ArchiveablePrimary, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, CabinetBased, Foldered, FolderEntry, wt.folder.FolderServiceManaged, IteratedFoldered, wt.iba.value.IBAHolder, DisplayIdentification, Indexable, WTContained, wt.inf.container.WTContainedFilterable, IteratedLifeCycleManaged, wt.lifecycle.LifeCycleManaged, Lockable, wt.maturity.Promotable, wt.meeting.actionitem.IteratedSubjectOfActionItem, wt.meeting.actionitem.SubjectOfActionItem, Notifiable, wt.org.electronicIdentity.ElectronicallySignable, OrganizationOwned, OrganizationOwnedVersion, Ownable, wt.recent.RecentlyVisited, wt.representation.Representable, wt.representation.RepresentablesAndMasters, wt.representation.RepresentationContributor, wt.team.TeamManaged, wt.type.FlexTyped, wt.type.Typed, wt.ufid.Federatable, wt.util.depthLock._DepthLock000, wt.util.depthLock._DepthLock001, wt.util.depthLock._DepthLock002, wt.util.depthLock._DepthLock003, wt.util.depthLock._DepthLock004, wt.util.depthLock._DepthLock005, wt.util.depthLock._DepthLock006, wt.util.depthLock._DepthLock007, Baselineable, Iterated, OneOffVersioned, Versionable, Versioned, Workable, wt.viewmarkup.Viewable, wt.workflow.forum.IteratedSubjectOfForum, wt.workflow.forum.SubjectOfForum, wt.workflow.notebook.IteratedSubjectOfNotebook, wt.workflow.notebook.SubjectOfNotebook, wt.workflow.requirement.RequirementsManageable

Direct Known Subclasses:

ProxyDocument

public class WTDocument
extends RevisionControlled
implements DocumentVersion, FormatContentHolder, Baselineable, wt.viewmarkup.Viewable, wt.workflow.requirement.RequirementsManageable, wt.type.Typed, WTContained, wt.enterprise.Templateable, wt.representation.Representable, OrganizationOwnedVersion, OneOffVersioned, wt.ufid.Federatable, Releasable, IdentityAccessControlled, wt.fc.archive.ArchiveablePrimary, 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

static String	DEPARTMENT Label for the attribute.
static String	DESCRIPTION Label for the attribute; Some text describing the document or noting important information that should be kept about a document.
static String	DOC_TYPE Label for the attribute.
static String	NAME Label for the attribute.
static String	NUMBER Label for the attribute.
static String	TITLE Label for the attribute; The official title of a document.

Fields inherited from class wt.enterprise.RevisionControlled

MASTER

Fields inherited from interface wt.org.OrganizationOwnedVersion

MASTER, MASTER_REFERENCE

Fields inherited from interface wt.org.OrganizationOwned

ORGANIZATION, ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Method Summary

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.
String	getName() Gets the value of the attribute: NAME.
String	getNumber() Gets the value of the attribute: NUMBER.
WTOrganization	getOrganization() Gets the value of the attribute: ORGANIZATION.
String	getOrganizationCodingSystem() Gets the value of the attribute: ORGANIZATION_CODING_SYSTEM.
String	getOrganizationName() Gets the value of the attribute: ORGANIZATION_NAME.
String	getOrganizationUniqueIdentifier() Gets the value of the attribute: ORGANIZATION_UNIQUE_IDENTIFIER.
String	getTitle() Gets the value of the attribute: TITLE.
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.
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	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	setName(String a_Name) Sets the value of the attribute: NAME.
void	setNumber(String a_Number) Sets the value of the attribute: NUMBER.
void	setOrganization(WTOrganization a_Organization) Sets the value of the attribute: ORGANIZATION.
void	setTitle(String a_Title) Sets the value of the attribute: TITLE.

Methods inherited from class wt.enterprise.RevisionControlled

getControlBranch, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationNote, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, isLatestIteration, setControlBranch, setMaster, setMasterReference

Methods inherited from class wt.fc.WTObject

getDisplayIdentifier, getDisplayIdentity, getDisplayType

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.org.OrganizationOwnedVersion

getMaster, getMasterReference

Field Detail

TITLE

public static final String TITLE

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

Supported API: true

See Also:

Constant Field Values

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

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

DOC_TYPE

public static final String DOC_TYPE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

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

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

getName

public String getName()

Gets the value of the attribute: NAME.

Supported API: true

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

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

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

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

Parameters:

a_Organization -

Throws:

WTPropertyVetoException