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