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:
: Promotes the document's current lifecycle state to the next state in its document lifecycle policy and sets the document'sPROMOTE
property to the name of the next state. Throws an error if the document is in the exception state, in the first state of its lifecycle, or does not allow demotion.CurrentState
: Demotes the document's current lifecycle state to the previous state in its document lifecycle policy and sets the document'sDEMOTE
property to the name of the previous state, unless theCurrentState
property of the document’s current state (CanBeDemoted
object) is set toDocumentState
. Throws an error if the document is in the exception state or in the first state of its lifecycle.false
: Places the document into the exception state and sets itsSET_EXCEPTION
property toIsInExceptionState
. Throws an error if the document'strue
property is already set toIsInExceptionState
.true
: Removes the document from the exception state and sets itsCLEAR_EXCEPTION
property toIsInExceptionState
. Throws an error if the document'sfalse
property is already set toIsInExceptionState
.false
: Resets the lifecycle state to the initial state in its document lifecycle policy and sets the document'sRESET
property to the name of the initial state. Throws an error if the document is in the exception state.CurrentState
Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Sub ChangeState( _ ByVal flags As LifecycleChangeFlags _ ) |
C# |
---|
void ChangeState( LifecycleChangeFlags flags ) |
C++ |
---|
void ChangeState( LifecycleChangeFlags flags ) abstract |
J# |
---|
void ChangeState( LifecycleChangeFlags flags ) |
JScript |
---|
function ChangeState( flags : LifecycleChangeFlags ) |
Parameters
- flags
- A
constant that specifies the new lifecycle state for this document.LifecycleChangeFlags