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 a 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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChangeState(LifecycleChangeFlags lifecycleAction) Creates a new instance of a ChangeState pending action object.

Method Summary

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ChangeState

public ChangeState(LifecycleChangeFlags lifecycleAction)

Creates a new instance of a ChangeState pending action object.

Parameters:

lifecycleAction - A LifecycleChangeFlags constant specifying the type of state transition to be applied to the document or task.

Throws:

E_BAD_PARAMETER - when you call the save method:

• If the lifecycleAction parameter is null.
• If the lifecycleAction parameter is PROMOTE, DEMOTE, or RESET, and the document has no document lifecycle policy defined.
• If the lifecycleAction parameter is PROMOTE, DEMOTE, RESET, or SET_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 unsupported RESET operation on a task. Thrown when you call the save 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.