DocumentStates
collection of its associated DocumentLifecyclePolicy
object. 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. To change the lifecycle state of a document, call its ChangeState
method; you can change a document's current lifecycle state to another predefined state, set it to an exception state, or clear it from an exception state by specifying the appropriate LifecycleChangeFlags
constant in the flags
parameter. To define the actions to take when a document’s lifecycle state is changed, write a Java handler class that implements the
interface and code the actions to be taken for each type of lifecycle state change in the appropriate method. After you have finished writing the Java handler, you have two choices:
- Check in the Java handler as a document and create a
object (using itsCodeModule
factory method). Set theCreateInstance
property of theCodeModule
object to the document that you checked in, and cast it as aDocumentLifecycleAction
object.CodeModule - Specify the Java handler in the classpath of your application server (it is not necessary to create a
object).CodeModule
Lastly, set the
property of the
object to the fully qualified package and class name of the Java handler.
The following tables list the members exposed by IDocumentLifecycleAction.
Public Properties
Name | Description | |
---|---|---|
![]() | DocumentLifecyclePolicies | Specifies a object that contains the collection of objects associated with this object store or object. |
Public Methods
Name | Description | |
---|---|---|
![]() | ChangeClass | Changes the class of a Content Engine object. The new class must already exist and both it and the original class must be subclasses of the same base class. The method does not modify the security for an object, even if the object's current security is derived from the default security for its source class. For the object's user-defined properties, the following rules apply:
When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's
|
See Also
FileNet.Api.Events Namespace
ChangeState
ICodeModule
IDocumentState
(broken link "!:FileNet.Api.Engine.IDocumentLifecycleActionHandler")
LifecycleChangeFlags