com.bea.wli.worklist.api.taskplan
Interface ReturnAction

All Superinterfaces:
Action, Comparable, EventSource, NamedIndexedObject, NamedObject, Serializable, StepAction

public interface ReturnAction
extends StepAction, Serializable

A return action causes a task that is currently claimed to be put back into the assigned working state. A returned task is not automatically reassigned. This may be accomplished using an assign action or the Worklist API (WorklistTaskAdmin.assignTask() method). Taking an return action is equivalent functionally to calling the Worklist API (WorklistTaskUser.returnTask() method).

When defining a return action, the task plan designer can specify the required properties the user must provide or verify the value of before taking this action.


Nested Class Summary
static interface ReturnAction.Event
          Property names for the PropertyChangeEvents that can be produced by edits on a object of this type.
 
Method Summary
 
Methods inherited from interface com.bea.wli.worklist.api.taskplan.StepAction
getStep
 
Methods inherited from interface com.bea.wli.worklist.api.taskplan.Action
addPropertyRef, addPropertyRef, getActionContainer, getPropertyNames, getPropertyRefs, removePropertyRef, removePropertyRef, setPropertyRefs
 
Methods inherited from interface com.bea.wli.worklist.api.taskplan.NamedIndexedObject
getIndex, setIndex
 
Methods inherited from interface com.bea.wli.worklist.api.taskplan.NamedObject
getDescription, getName, setDescription
 
Methods inherited from interface com.bea.wli.worklist.api.taskplan.EventSource
addPropertyChangeListener, addPropertyChangeListener, clearDirty, dispose, getParent, isComplete, isDirty, isInitializing, isStarted, markDirty, removePropertyChangeListener, removePropertyChangeListener, startProducing
 
Methods inherited from interface java.lang.Comparable
compareTo