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

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

public interface AssignAction
extends StepAction, Serializable

An assign action forces a task into the assigned working state, and assigns that task given existing assignment instructors or, optionally, assignment instructions specified on the assign action itself. Taking an assign action is equivalent functionally to calling the Worklist API (WorklistTaskAdmin.assignTask() method). However, an assign action can be taken by a claimant even though the claimant cannot directly reassign the task using the Worklist API. This allows the task plan designer to indicate when it is appropriate for a claimant to reassign a task without allowing the claimant to reassign the task in all cases.

When defining an assign action, the task plan designer can specify the assignment instructions to use, and required properties the user must provide or verify the value of before taking this action.


Nested Class Summary
static interface AssignAction.Event
          Property names for the PropertyChangeEvents that can be produced by edits on a object of this type.
 
Method Summary
 AssignmentInstructions getAssignmentInstructions()
          Get the assignment instructions to use when taking this action (may be null).
 void setAssignmentInstructions(AssignmentInstructions instructions)
           
 
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
 

Method Detail

getAssignmentInstructions

AssignmentInstructions getAssignmentInstructions()
Get the assignment instructions to use when taking this action (may be null). If null, this indicates that, at runtime, the 'context' assignment instructions will be used (this is either the instructions on the host step for this action or the last used assignment instructions for the task.


setAssignmentInstructions

void setAssignmentInstructions(AssignmentInstructions instructions)