com.filenet.api.action
Class ChangeState
- java.lang.Object
-
- com.filenet.api.action.PendingAction
-
- com.filenet.api.action.ChangeState
-
- All Implemented Interfaces:
- java.io.Serializable
public class ChangeState extends PendingAction
Represents a pending action for changing the lifecycle policy state of aDocument
, or for changing the state of aCmTask
. When thechangeState
method is called onDocument
orCmTask
, the API automatically creates an instance of theChangeState
class and adds it to the underlying object's collection ofPendingAction
objects.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor and Description ChangeState(LifecycleChangeFlags lifecycleAction)
Creates a new instance of aChangeState
pending action object.
-
Method Summary
Methods Modifier and Type Method and Description LifecycleChangeFlags
getLifecycleAction()
Returns the new lifecycle state for the underlying object of this pending action.-
Methods inherited from class com.filenet.api.action.PendingAction
getBinaryListValue, getBinaryValue, getBooleanListValue, getBooleanValue, getDateTimeListValue, getDateTimeValue, getEngineObjectValue, getFloat64ListValue, getFloat64Value, getIdListValue, getIdValue, getInteger32ListValue, getInteger32Value, getObjectValue, getStringListValue, getStringValue, putObjectValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, toString
-
-
-
-
Constructor Detail
-
ChangeState
public ChangeState(LifecycleChangeFlags lifecycleAction)
Creates a new instance of aChangeState
pending action object.- Parameters:
lifecycleAction
- ALifecycleChangeFlags
constant specifying the type of state transition to be applied to the document or task.- Throws:
E_BAD_PARAMETER
- when you call thesave
method:- If the lifecycleAction parameter is null.
- If the lifecycleAction parameter is
PROMOTE, DEMOTE,
orRESET
, and the document has no document lifecycle policy defined. - If the lifecycleAction parameter is
PROMOTE, DEMOTE, RESET,
orSET_EXCEPTION
, and the document or task is already in an exception state. - If the lifecycleAction parameter is
CLEAR_EXCEPTION
and the document or task is not in an exception state.
E_NOT_SUPPORTED
- if the document is a reservation object, if you attempt to promote or demote a task from a state that does not allow promotion or demotion, or if you attempt the unsupportedRESET
operation on a task. Thrown when you call thesave
method.
-
-
Method Detail
-
getLifecycleAction
public LifecycleChangeFlags getLifecycleAction()
Returns the new lifecycle state for the underlying object of this pending action.- Returns:
- A
LifecycleChangeFlags
constant specifying the new lifecycle policy state.
-
-