Package wt.doc

Class WTDocument

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.enterprise._RevisionControlled
wt.enterprise.RevisionControlled
wt.doc._WTDocument
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:
_ProxyDocument
@GenAsPersistable(superClass=RevisionControlled.class,interfaces={wt.doc.DocumentVersion.class,FormatContentHolder.class,Baselineable.class,wt.viewmarkup.Viewable.class,wt.workflow.requirement.RequirementsManageable.class,wt.type.Typed.class,WTContained.class,wt.enterprise.Templateable.class,Representable.class,OrganizationOwnedVersion.class,OneOffVersioned.class,wt.ufid.Federatable.class,Releasable.class,wt.access.IdentityAccessControlled.class,wt.fc.archive.ArchiveablePrimary.class,wt.sandbox.Interoperable.class,PersistedCollectable.class,wt.folder.history.Movable.class,wt.doc.WTDocumentTypeInterface.class,EffManagedVersion.class,wt.projmgmt.deliverable.VersionedSubjectOfDeliverable.class,IteratedTraceable.class},extendable=true,versions={-8938629559560808781L,545931576889465110L},properties={@GeneratedProperty(name="title",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="The official title of a document.",constraints=@PropertyConstraints(upperLimit=64)),@GeneratedProperty(name="description",type=java.lang.String.class,supportedAPI=PUBLIC,javaDoc="Some text describing the document or noting important information that should be kept about a document.",constraints=@PropertyConstraints(upperLimit=4000)),@GeneratedProperty(name="department",type=DepartmentList.class,supportedAPI=PUBLIC,constraints=@PropertyConstraints(upperLimit=30,required=true)),@GeneratedProperty(name="docType",type=DocumentType.class,supportedAPI=PUBLIC,constraints=@PropertyConstraints(changeable=VIA_OTHER_MEANS,required=true))},foreignKeys=@GeneratedForeignKey(foreignKeyRole=@ForeignKeyRole(name="master",type=WTDocumentMaster.class,cascade=false,constraints=@PropertyConstraints(required=true),accessors=@PropertyAccessors(getAccess=PRIVATE)),myRole=@MyRole(name="iteration",cascade=false,accessors=@PropertyAccessors(getAccess=PRIVATE,setAccess=PROTECTED))),derivedProperties={@DerivedProperty(name="name",derivedFrom="master>name",supportedAPI=PUBLIC),@DerivedProperty(name="number",derivedFrom="master>number",supportedAPI=PUBLIC)},tableProperties=@TableProperties(compositeIndex2="+ docType + state.state",compositeIndex3="+ docType + state.state",compositeIndex5="+ domainRef.key.id",compositeUnique1="+oneOffVersionInfo.identifier.oneOffVersionId",oracleTableSize=HUGE),iconProperties=@IconProperties(standardIcon="netmarkets/images/doc_document.gif",openIcon="netmarkets/images/doc_document.gif")) public class WTDocument extends _WTDocument
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:

  • Method Details