public class ChangeState extends PendingAction
Document
,
or for changing the state of a CmTask
.
When the changeState
method is called on Document
or CmTask
,
the API automatically creates an instance of the ChangeState
class and adds it to the underlying object's
collection of PendingAction
objects.Constructor and Description |
---|
ChangeState(LifecycleChangeFlags lifecycleAction)
Creates a new instance of a
ChangeState pending action object. |
Modifier and Type | Method and Description |
---|---|
LifecycleChangeFlags |
getLifecycleAction()
Returns the new lifecycle state for the underlying object of this pending action.
|
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
public ChangeState(LifecycleChangeFlags lifecycleAction)
ChangeState
pending action object.lifecycleAction
- A LifecycleChangeFlags
constant specifying the type of state transition to be applied to the document or task.E_BAD_PARAMETER
- when you call the save
method:
PROMOTE, DEMOTE,
or RESET
, and the document
has no document lifecycle policy defined.PROMOTE, DEMOTE, RESET,
or SET_EXCEPTION
,
and the document or task is already in an exception state.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 unsupported RESET
operation on a task.
Thrown when you call the save
method.public LifecycleChangeFlags getLifecycleAction()
LifecycleChangeFlags
constant specifying the new lifecycle policy state.© Copyright IBM Corporation 2006, 2015. All rights reserved.