Represents a single version of a document stored in an object store. In addition to being versionable, a
object can be subclassed and can carry content, which is stored in one or more content elements. Each content element represents content data, which can either be local to an object store (represented by a
object) or external to an object store and therefore outside the control of the Content Engine server (represented by a
object). In addition, a
object can be associated with a document lifecycle policy. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the transition of those states, and specifies the actions to be taken when a document's lifecycle state changes.
The following tables list the members exposed by IDocument.
Public Properties
Name | Description | |||||
---|---|---|---|---|---|---|
![]() |
ChildDocuments | A collection object that contains the child objects bound to this parent document. The collection contains only those child documents for which the user has read access. For each object that references this document as the parent component document, the collection contains the version of the child component document that is bound to this parent document. The same child document can be in the collection more than once. For information on the ordering of the collection, see the |
||||
![]() |
ChildRelationships | A collection object that contains the objects referencing this document as the parent component document. For information on the ordering of the collection, see the |
||||
![]() |
ClassificationStatus | Specifies a constant that indicates the auto-classification status for this document. The property is used to provide client applications a means of discovering whether a particular document is subject to auto-classification, and if so, whether or not the operation was successful. This property can hold one of the following values:
|
||||
![]() |
CompoundDocumentState | The setting that determines whether a document can be a parent component in a compound document. The Valid settings are:
|
||||
![]() |
ContentElements | Specifies a object containing the list of content elements associated with this document or annotation. Each content element represents content data, which can either be local to an object store and stored in a file store or database (represented by a object) or external to an object store and therefore outside the control of the Content Engine server (represented by a object). |
||||
![]() |
ContentElementsPresent | Specifies a object containing the MIME type of each content element |
||||
![]() |
ContentRetentionDate | Specifies the date until which this checked-in document must be retained, as determined by the content storage subsystem. This document can be deleted only after this date has passed. | ||||
![]() |
ContentSize | Specifies the size in bytes of the content data associated with this document, annotation, or object. Note that if the document or annotation has more than one content element, then the size is the sum of all of the content elements. |
||||
![]() |
CurrentState | Specifies the name of the current lifecycle state of this document as defined by its document lifecycle policy. Each document lifecycle policy defines a set of states through which a property of the object representing the document can transition into during its lifecycle. This property is equal to the value of the current lifecycle state of this document. |
||||
![]() |
DateContentLastAccessed | Specifies the date and time when the content data (represented by a object) associated with this document or annotation was last accessed. The Content Engine stores dates and times using Coordinated Universal Time (UTC). The recording granularity of the date and time returned by this property is determined by the setting of the object store's property. The content data associated with a document or annotation object is considered to be accessed when one of the following events occur:
property. Note that even if the content data is larger than the user-specified chunk size and multiple trips to the database or cache are required, the property will be set only to the date and time that the content data was first accessed. Applications that access content data frequently will cause continual updates of the property by the server, which can result in degraded performance. Therefore, it is recommended that you set the property to control the frequency that the property is updated. |
||||
![]() |
DependentDocuments | Specifies a collection object that contains all of the publication documents to which this document is the owner document. |
||||
![]() |
DestinationDocuments | Specifies documents that are publications of this document. This property is a reflective property of the property. |
||||
![]() |
DocumentLifecyclePolicy | Specifies the object that represents the lifecycle policy that has been applied to this document. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the transition of those states, and specifies the actions to be taken when a document's lifecycle state changes. |
||||
![]() |
IndexationId | The object ID (GUID) of the Verity collection used. This will be for objects that were full text indexed prior to the 4.0 release. This property must be set if the property is to be CBR enabled (the |
||||
![]() |
IsInExceptionState | Specifies whether the lifecycle state of this document is in an exception state ( ) or not ( ). As long as a document is in an exception state, its lifecycle state can neither be promoted nor demoted. To clear a document from an exception state, you must call its method and set the parameter to . |
||||
![]() |
MimeType | Specifies the Multipurpose Internet Mail Extensions (MIME) format string of the content data carried by this document, annotation, or document classification action. For For For Each content element that is attached to a document or annotation has its own MIME type, which is specified by its
MIME is a communications protocol that allows for the transmission of data in many forms, such as audio, binary, or video. A MIME format string consists of a content type, a content subtype, and an optional parameter in the format: "MIME::content type/subtype[;parameter]". For example: "MIME::text/html". MIME defines the following content types:
The following MIME types are specific to FileNet:
|
||||
![]() |
OwnerDocument | For a published document, contains a reference to the object representing the owner document associated with the published document. If this document is a publication and there is a cascade delete relationship with the source, then this property will specify the publication source document (the and properties will reference the same document). |
||||
![]() |
ParentDocuments | A collection object that contains the parent objects bound to this child document. The collection contains only those parent documents for which the user has read access. For each object that references this document as the child component document, the collection contains the parent component document. The same parent document can be in the collection more than once. |
||||
![]() |
ParentRelationships | A collection object that contains the objects referencing this document as the child component document. The collection contains only those parent relationship objects for which the user has read access. |
||||
![]() |
PublicationInfo | Specifies the parameters (formatted as XML) that were used to publish a document. The parameters, which are used to republish the document, include the original output folder ID, style template ID, publish template ID, and publish template version series ID. For example:
If the document is not a publication, the property is empty. |
||||
![]() |
PublishingSubsidiaryFolder | Specifies a folder which contains the subsidiary documents of an HTML publication (for example, image, audio, and style sheet files). | ||||
![]() |
ReleasedVersion | Specifies a document version that represents the latest released version associated with this document or version series. A released version is a major version that has a property value of . Note that only one document version at a time in a given version series can be in the released state. |
||||
![]() |
SecurityParent |
Obsolete.
Specifies the object from which a given object inherits security. The value of this property is a (or ) that represents the object from which security is inherited. An object can inherit its permissions from its security parent. For example, a |
||||
![]() |
SourceDocument | Specifies the source document for a published document. | ||||
![]() |
StorageArea | Specifies the storage area for a content-carrying object. | ||||
![]() |
StorageLocation | Specifies the storage location for an object's content. This property is deprecated in FileNet P8 4.0 and is only set in upgraded object stores. It has been replaced by the StorageArea property. | ||||
![]() |
StoragePolicy | Specifies the document's storage policy, which identifies the set of available storage areas that are considered equivalent based on common, user-specified criteria. Assigning a storage policy to a document is the recommended method of selecting a storage area. The alternative is to directly assign the storage area (specify the StorageArea property). When a document is created, the order of precedence for setting the storage on the
The default ClassDefinition for a document sets the StorageArea to "Database Storage Area" and the StoragePolicy to "All Storage Areas". Therefore, if you create a new To avoid this situation, you must set the instance value for the document's StorageArea property to In general, storage policies should be used to allow administrators to properly administer their storage systems. They can assign multiple storage areas to be load balanced, and also assign standby storage areas to be used if any of the current storage areas become full. |
||||
![]() |
WorkflowSubscriptions | The IInstanceWorkflowSubscriptionSet object containing the IInstanceWorkflowSubscription objects whose target is this object. |
Public Methods
Name | Description | |
---|---|---|
![]() |
AccessContentStream | Obtains read access, via an input stream, to the content data of a content element associated with this document or annotation. If content data is not present in the object’s property cache, it will be fetched from the server. The Content Engine will not automatically close the stream after access has finished; unless you want the stream to remain open, your application should close the stream after it has finished reading the content data. An error occurs if the parameter specifies an invalid index, no content elements exist on this document or annotation, or the content element is not a object. |
![]() |
ApplySecurityTemplate | Applies a security policy template to the given object. The specified value for the parameter must match the value of the ApplyStateID property of one of the templates in the security policy for the object. For a versioning security template, the apply state ID can be one of the following: For an application security template, the apply state ID is defined by your application. |
![]() |
ChangeState | Changes the current lifecycle state of this document. Note that you cannot change the state of a document that is a reservation object. Valid lifecycle states are defined by the collection of objects belonging to this document's associated object. You can change a document's current lifecycle state to another predefined state, place a document into the exception state, or remove a document from the exception state by specifying a constant in the parameter as follows:
|
![]() |
Checkin | Checks in this document reservation object by saving it as a new document version. You must have the appropriate access rights to check in a document ( to check it in a major version or to check it in a minor version). A major version is either the current released document version (if it is the latest major version) or a former released version that was superseded. A minor version is either the in-process document version (if it is the latest minor version) or a former in-process version that was superseded. In addition, if the reservation object is an exclusive reservation (its property is set to ), you must be the reservation owner (the reservation owner's name is the value of the reservation object's property) or have the access right. An error will occur if this method is called by a document that is not a reservation object. Before you can check in a document that has content, you must set the content for the document by adding to its The |
![]() |
GetPublicationStatus | Returns a enumeration value, which identifies the document's publication status (dependent, independent, or not a publication). object. |
![]() |
IsLocked | Queries this object's lock state. This helper method examines the object's lock-related properties and determines the object's lock state. An alternative approach is to call the method and handle any exception thrown if the method fails. Note that this method returns an approximation of the locked state at the time of the call. Once this method executes and returns the value, the object's lock state could be immediately changed by another application's call to the Before calling this method, make sure that the object's LockToken, LockTimeout, and DateLastModified properties have relatively fresh values. If any of those properties is missing, they are silently fetched from the server and added to the object's property cache. The Note: Note: To successfully run |
![]() |
LockObject | Sets a new lock or updates an existing lock on the object. Calling this method has no effect in preventing others from updating a locked object (with the exception that others cannot re-lock the locked object). This lock mechanism is used for custom purposes only and has no bearing on the actual ability to update an object. To successfully execute this method, the current user must have permission to modify this object's properties. For example, locking a If the call succeeds:
To update an existing lock, the objects needs to be in the locked state and the current user needs to match the user of the lock. Note that the user is the logged in user, not the |
![]() |
MoveContent | Moves the content data of an object to a new storage area. |
![]() |
Publish | Publishes this object according to the specifications included in the specified publish template as modified by the contents of the parameter. This method returns the object that is queued for this request. All publish requests are asynchronous, including copy operations, which do not transform the document. A publish request is always enqueued, and a copy of the object is always returned to the caller. The publish template you specify, as well as any objects specified in the publish template itself, must reside on the same object store as this The After a successful call to |
![]() |
Republish | Republishes the specified published document. The specified published document must have been published with a publish template that still exists and had this object as its source document. This method returns the object that is queued for this request. All publish requests are asynchronous, including copy operations, which do not transform the document. A publish request is always enqueued, and a copy of the object is always returned to the caller. The |
![]() |
TakeFederatedOwnership | For a document that has been federated by Content Federation Services (CFS), grants exclusive control of this document to the FileNet P8 Content Engine by making the corresponding external document read-only. (Since the external document ceases to change, no changes exist for CFS to propagate from the external repository to the Content Engine, and the Content Engine becomes the sole means for modifying or deleting the document.) For non-federated documents or for documents for which this method has already been called, this method has no effect. An error is generated if this document is a reservation object ( property is set to ). |
![]() |
Unlock | Explicitly removes the lock from this object. Only the user who locked the object may remove the lock. If the current user is not the user of the lock, the current user can still remove the lock provided that user has permission on the object. An exception is thrown if the above conditions are not met. Upon successful execution of this method, the values for the object's LockOwner, LockToken, and LockTimeout properties are removed (set to ). If you do not call to explicitly remove the lock, the lock is implicitly removed when the lock's timeout value expires. |
![]() |
UpdateLock | Adjusts the timeout period of the lock on this object. This method updates the object's DateLastModified property to the current time and its LockTimeout property to the timeout value. The net effect of this may extend or shorten the original lock's expiration time. Only the user who locked the object can successfully call this method; for any other user, an exception is thrown. There is no limit to the number of times you can call this method. |