Package wt.doc

Class _WTDocument

java.lang.Object

wt.fc._WTObject

wt.fc.WTObject

wt.enterprise._RevisionControlled

wt.enterprise.RevisionControlled

wt.doc._WTDocument

All Implemented Interfaces:

com.ptc.windchill.bac._BACManaged, com.ptc.windchill.bac.BACManaged, Externalizable, Serializable, wt.access._AccessControlled, wt.access._AccessControlList, wt.access._AdHocControlled, wt.access._IdentityAccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.AccessControlList, AdHocControlled, wt.access.IdentityAccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.change2._Changeable2, wt.change2._ChangeableIfc, Changeable2, ChangeableIfc, wt.content._ContentHolder, wt.content._FormatContentHolder, ContentHolder, FormatContentHolder, wt.doc._Document, wt.doc._DocumentVersion, wt.doc._WTDocumentTypeInterface, Document, wt.doc.DocumentVersion, wt.doc.WTDocumentTypeInterface, wt.eff._EffManagedVersion, wt.eff._EffRecordable, EffManagedVersion, EffRecordable, wt.enterprise._Templateable, wt.enterprise.Templateable, wt.esi._Releasable, Releasable, wt.facade.persistedcollection._PersistedCollectable, PersistedCollectable, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, wt.fc.archive._Archiveable, wt.fc.archive._ArchiveablePrimary, wt.fc.archive.Archiveable, wt.fc.archive.ArchiveablePrimary, wt.fc.BusinessInformation, NetFactor, ObjectMappable, Persistable, wt.federation._FederatedLinkHolder, wt.federation._RemotelyLinkable, wt.federation.FederatedLinkHolder, wt.federation.RemotelyLinkable, wt.folder._CabinetBased, wt.folder._Foldered, wt.folder._FolderEntry, wt.folder._FolderServiceManaged, wt.folder._IteratedFoldered, CabinetBased, Foldered, FolderEntry, wt.folder.FolderServiceManaged, wt.folder.history.Movable, IteratedFoldered, wt.iba.value._IBAHolder, wt.iba.value.IBAHolder, DisplayIdentification, wt.index._Indexable, Indexable, wt.inf.container._WTContained, wt.inf.container._WTContainedFilterable, WTContained, wt.inf.container.WTContainedFilterable, wt.lifecycle._IteratedLifeCycleManaged, _LifeCycleManaged, IteratedLifeCycleManaged, LifeCycleManaged, wt.locks._Lockable, Lockable, wt.maturity._Promotable, Promotable, wt.meeting.actionitem._IteratedSubjectOfActionItem, wt.meeting.actionitem._SubjectOfActionItem, wt.meeting.actionitem.IteratedSubjectOfActionItem, wt.meeting.actionitem.SubjectOfActionItem, wt.notify._Notifiable, Notifiable, _OrganizationOwned, wt.org._OrganizationOwnedVersion, wt.org.electronicIdentity._ElectronicallySignable, wt.org.electronicIdentity.ElectronicallySignable, OrganizationOwned, OrganizationOwnedVersion, wt.ownership._Ownable, wt.ownership.Ownable, wt.projmgmt.deliverable._SubjectOfDeliverable, wt.projmgmt.deliverable._VersionedSubjectOfDeliverable, wt.projmgmt.deliverable.SubjectOfDeliverable, wt.projmgmt.deliverable.VersionedSubjectOfDeliverable, wt.recent.RecentlyVisited, wt.representation._Representable, wt.representation._RepresentablesAndMasters, wt.representation._RepresentationContributor, Representable, wt.representation.RepresentablesAndMasters, wt.representation.RepresentationContributor, wt.sandbox._Interoperable, wt.sandbox.Interoperable, _TeamManaged, TeamManaged, wt.trace._IteratedTraceable, wt.trace._Traceable, IteratedTraceable, Traceable, wt.type._Typed, wt.type._TypeManaged, wt.type.FlexTyped, wt.type.Typed, wt.type.TypeManaged, wt.ufid._Federatable, wt.ufid.Federatable, _Iterated, wt.vc._OneOffVersioned, wt.vc._Versionable, wt.vc._Versioned, wt.vc.baseline._Baselineable, Baselineable, Iterated, OneOffVersioned, Versionable, Versioned, wt.vc.wip._Workable, Workable, wt.viewmarkup._Viewable, wt.viewmarkup.Viewable, wt.workflow.forum._IteratedSubjectOfForum, wt.workflow.forum._SubjectOfForum, wt.workflow.forum.IteratedSubjectOfForum, SubjectOfForum, wt.workflow.notebook._IteratedSubjectOfNotebook, wt.workflow.notebook._SubjectOfNotebook, wt.workflow.notebook.IteratedSubjectOfNotebook, wt.workflow.notebook.SubjectOfNotebook, wt.workflow.requirement._RequirementsManageable, wt.workflow.requirement.RequirementsManageable

Direct Known Subclasses:

WTDocument

public abstract class _WTDocument
extends RevisionControlled
implements wt.doc.DocumentVersion, FormatContentHolder, Baselineable, wt.viewmarkup.Viewable, wt.workflow.requirement.RequirementsManageable, wt.type.Typed, WTContained, wt.enterprise.Templateable, Representable, OrganizationOwnedVersion, OneOffVersioned, wt.ufid.Federatable, Releasable, wt.access.IdentityAccessControlled, wt.fc.archive.ArchiveablePrimary, wt.sandbox.Interoperable, PersistedCollectable, wt.folder.history.Movable, wt.doc.WTDocumentTypeInterface, EffManagedVersion, wt.projmgmt.deliverable.VersionedSubjectOfDeliverable, IteratedTraceable, Externalizable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEPARTMENT	Supported API: true
static final String	DESCRIPTION	Some text describing the document or noting important information that should be kept about a document.
static final String	DOC_TYPE	Supported API: true
static final String	NAME	Supported API: true
static final String	NUMBER	Supported API: true
static final String	TITLE	The official title of a document.

Fields inherited from interface wt.vc._Iterated

CONTROL_BRANCH, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_NOTE, LATEST_ITERATION, MASTER, MASTER_REFERENCE, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Fields inherited from interface wt.lifecycle._LifeCycleManaged

LIFE_CYCLE_STATE, STATE

Fields inherited from interface wt.org._OrganizationOwned

ORGANIZATION_CODING_SYSTEM, ORGANIZATION_NAME, ORGANIZATION_UNIQUE_IDENTIFIER

Fields inherited from interface wt.team._TeamManaged

TEAM_ID, TEAM_TEMPLATE_ID

Method Summary

Modifier and Type	Method	Description
DepartmentList	getDepartment()	Supported API: true
String	getDescription()	Some text describing the document or noting important information that should be kept about a document.
DocumentType	getDocType()	Supported API: true
String	getName()	Derived from _WTDocumentMaster.getName()
String	getNumber()	Derived from _WTDocumentMaster.getNumber()
String	getOrganizationCodingSystem()	Supported API: true
String	getOrganizationName()	Supported API: true
String	getOrganizationUniqueIdentifier()	Supported API: true
String	getTitle()	The official title of a document.
void	setDepartment(DepartmentList department)	Supported API: true
void	setDescription(String description)	Some text describing the document or noting important information that should be kept about a document.
void	setDocType(DocumentType docType)	Supported API: true
void	setName(String name)	Derived from _WTDocumentMaster.setName(java.lang.String)
void	setNumber(String number)	Derived from _WTDocumentMaster.setNumber(java.lang.String)
void	setTitle(String title)	The official title of a document.

Methods inherited from class wt.enterprise._RevisionControlled

getControlBranch, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationNote, getLifeCycleState, getMaster, getMasterReference, getModifier, getModifierEMail, getModifierFullName, getModifierName, getState, getTeamId, getTeamTemplateId, isLatestIteration, 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.vc._Iterated

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

Methods inherited from interface wt.org.OrganizationOwned

getOrganization

Methods inherited from interface wt.fc.Persistable

checkAttributes

Field Details

TITLE

public static final String TITLE

The official title of a document.

Supported API: true

See Also:

• WTDocument
• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

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

Supported API: true

See Also:

• WTDocument
• Constant Field Values

DEPARTMENT

public static final String DEPARTMENT

Supported API: true

See Also:

• WTDocument
• Constant Field Values

DOC_TYPE

public static final String DOC_TYPE

Supported API: true

See Also:

• WTDocument
• Constant Field Values

NAME

public static final String NAME

Supported API: true

See Also:

• WTDocument
• Constant Field Values

NUMBER

public static final String NUMBER

Supported API: true

See Also:

• WTDocument
• Constant Field Values

Method Details

getTitle

public String getTitle()

The official title of a document.

Supported API: true

See Also:

• WTDocument

setTitle

public void setTitle(String title)
              throws WTPropertyVetoException

The official title of a document.

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• WTDocument

getDescription

public String getDescription()

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

Supported API: true

See Also:

• WTDocument

setDescription

public void setDescription(String description)
                    throws WTPropertyVetoException

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

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• WTDocument

getDepartment

public DepartmentList getDepartment()

Supported API: true

See Also:

• WTDocument

setDepartment

public void setDepartment(DepartmentList department)
                   throws WTPropertyVetoException

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• WTDocument

getDocType

public DocumentType getDocType()

Supported API: true

See Also:

• WTDocument

setDocType

public void setDocType(DocumentType docType)
                throws WTPropertyVetoException

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• WTDocument

getName

public String getName()

Derived from _WTDocumentMaster.getName()

Supported API: true

Specified by:

getName in interface CabinetBased

Specified by:

getName in interface wt.projmgmt.deliverable.SubjectOfDeliverable

Overrides:

getName in class RevisionControlled

Returns:

String

See Also:

• WTDocument

setName

public void setName(String name)
             throws WTPropertyVetoException

Derived from _WTDocumentMaster.setName(java.lang.String)

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• WTDocument

getNumber

public String getNumber()

Derived from _WTDocumentMaster.getNumber()

Supported API: true

See Also:

• WTDocument

setNumber

public void setNumber(String number)
               throws WTPropertyVetoException

Derived from _WTDocumentMaster.setNumber(java.lang.String)

Supported API: true

Throws:

WTPropertyVetoException

See Also:

• WTDocument

getOrganizationUniqueIdentifier

public String getOrganizationUniqueIdentifier()

Supported API: true

Specified by:

getOrganizationUniqueIdentifier in interface _OrganizationOwned

See Also:

• OrganizationOwned

getOrganizationCodingSystem

public String getOrganizationCodingSystem()

Supported API: true

Specified by:

getOrganizationCodingSystem in interface _OrganizationOwned

See Also:

• OrganizationOwned

getOrganizationName

public String getOrganizationName()

Supported API: true

Specified by:

getOrganizationName in interface _OrganizationOwned

See Also:

• OrganizationOwned