DocumentState
object for each lifecycle state that you want to define and add it to a DocumentLifecyclePolicy
object's DocumentStates
collection. Each lifecycle state must have a name, which is set by the
property. Each lifecycle state name must be unique within the lifecycle policy in which it is defined. To specify whether a given lifecycle state can be demoted or not, set its
property.
The order of the lifecycle states in a document lifecycle policy's
collection is important and determines the succession of lifecycle states. When a document that is associated with a document lifecycle policy is created, its initial lifecycle state is the first
object in the document lifecycle policy's
collection. To move a document into the next lifecycle state defined in the document lifecycle policy's
collection, call the document's
method and set its
parameter to the
constant. To move a document into the previous lifecycle state (unless the document's current lifecycle state's
property is set to
), set the method's
parameter to
.
The template permissions specified by the
property will be applied during a lifecycle state change if you set the
property to
; otherwise the permissions will not be applied. If the
property to set to
and you reset a document's lifecycle state, either by calling its
method and specifying
or by calling its
method while the
property on its document lifecycle policy is set to
, the access permissions will be reset to the access permissions of the initial lifecycle state.
Namespace: FileNet.Api.Events
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Interface IDocumentState Implements IRepositoryObject, IEngineObject, ICloneable, IDependentObject |
C# |
---|
public interface IDocumentState : IRepositoryObject, IEngineObject, ICloneable, IDependentObject |
C++ |
---|
interface class IDocumentState : IRepositoryObject, IEngineObject, ICloneable, IDependentObject |
J# |
---|
public interface IDocumentState implements IRepositoryObject, IEngineObject, ICloneable, IDependentObject |
JScript |
---|
public interface IDocumentState extends IRepositoryObject, IEngineObject, ICloneable, IDependentObject |
Remarks
Metadata
Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: true
IsHidden: false
Searchable: false
StorageType: ObjectStore
SuperclassName: GenericObject