Represents the actions to be taken when a document's lifecycle state is changed. A document's lifecycle states are defined in the
Namespace: FileNet.Api.Events
Assembly: FileNet.Api (in filenet.api.dll)
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.
Namespace: FileNet.Api.Events
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Interface IDocumentLifecycleAction Implements IAction, IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
C# |
---|
public interface IDocumentLifecycleAction : IAction, IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
C++ |
---|
interface class IDocumentLifecycleAction : IAction, IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
J# |
---|
public interface IDocumentLifecycleAction implements IAction, IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
JScript |
---|
public interface IDocumentLifecycleAction extends IAction, IRepositoryObject, IReplicable, ISubscribable, IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable |
Remarks
Metadata
Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: Action
See Also
IDocumentLifecycleAction Members
FileNet.Api.Events Namespace
ChangeState
ICodeModule
IDocumentState
(broken link "!:FileNet.Api.Engine.IDocumentLifecycleActionHandler")
LifecycleChangeFlags
FileNet.Api.Events Namespace
ChangeState
ICodeModule
IDocumentState
(broken link "!:FileNet.Api.Engine.IDocumentLifecycleActionHandler")
LifecycleChangeFlags