|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Step
Represents a discrete step in the completion of a human interaction worklist task. Tasks may have multiple steps. Each step defines actions that a human user may take to make a task proceed to the next step in its step model.
Nested Class Summary | |
---|---|
static interface |
Step.Event
Property names for the PropertyChangeEvents that can be produced by edits on a object of this type. |
static class |
Step.Type
|
Method Summary | |
---|---|
void |
addActionConnectorToTarget(ActionConnector connector)
Internal use only. |
AssignAction |
addAssignAction(String name)
Will create an AssignAction and add it to the step. |
AssignToNextUserAction |
addAssignToNextUserAction(String name)
Will create an ActionConnector and add it to 'this' as the source. |
ReturnAction |
addReturnAction(String name)
Will create a ReturnAction and add it to the step. |
StepWorkAction |
addWorkAction(String name)
Will create an ActionConnector and add it to 'this' as the source. |
AssignmentInstructions |
createAssignmentInstructions()
Create and set the instructions that will be used to perform assignment on a task when this step is the current step for that task. |
BusinessDateTime |
createCompletionDueBusinessDate()
Create and set the completion due business date for this step. |
Interval |
createTimeEstimate()
Create and set the Interval instance representing the estimated time it will take to complete this task. |
void |
destroyAssignmentInstructions()
Destroy and unset the assignment instructions for this step. |
void |
destroyCompletionDueBusinessDate()
Destroy and unset the completion due business date for this step. |
void |
destroyTimeEstimate()
Destroy and unset the time estimate for this step. |
AssignAction |
getAssignAction(String name)
Get the assign action with the given name. |
AssignmentInstructions |
getAssignmentInstructions()
Get the assignmentInstructions that will be used for assignment of tasks at this step. |
AssignToNextUserAction |
getAssignToNextUserAction(String name)
Get the assing-to-next-user action with the given name. |
BusinessDateTime |
getCompletionDueBusinessDate()
Business date and time by which this step must be completed. |
ReturnAction |
getReturnAction(String name)
Get the return action with the given name. |
StepAction |
getStepAction(String name)
Get step action with the given name. |
List<ActionConnector> |
getTargetActionConnectors()
Internal use only. |
Interval |
getTimeEstimate()
An estimate of the time it will take to complete this step of the task. |
Step.Type |
getType()
Indicates the type associated with this step. |
StepWorkAction |
getWorkAction(String name)
Get the work action with the given name. |
void |
removeActionConnectorFromTarget(ActionConnector connector)
Internal use only. |
void |
setAssignmentInstructions(AssignmentInstructions instructions)
Set the instructions that will be used to perform assignment on a task when this step is the current step for that task. |
void |
setCompletionDueBusinessDate(BusinessDateTime dateTime)
Set the completion due business date for this step. |
void |
setTimeEstimate(Interval estimate)
Set the Interval instance representing the estimated time it will take to complete this task. |
void |
setType(Step.Type type)
|
Methods inherited from interface com.bea.wli.worklist.api.taskplan.ActionContainer |
---|
getAction, getActionNames, getSourceActionConnectors, getTaskPlan, moveAction |
Methods inherited from interface com.bea.wli.worklist.api.taskplan.NamedObjectContainer |
---|
addChild, addChild, clear, getChild, getChildNames, getChildObjects, hasChild, removeChild, renameChild |
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 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 com.bea.wli.worklist.api.taskplan.Bounded |
---|
getBounds, setBounds |
Method Detail |
---|
Step.Type getType()
void setType(Step.Type type)
BusinessDateTime getCompletionDueBusinessDate()
void setCompletionDueBusinessDate(BusinessDateTime dateTime)
createCompletionDueBusinessDate()
,
TaskPlanFactory.createBusinessDateTime()
BusinessDateTime createCompletionDueBusinessDate()
destroyCompletionDueBusinessDate()
void destroyCompletionDueBusinessDate()
createCompletionDueBusinessDate()
Interval getTimeEstimate()
createTimeEstimate()
void setTimeEstimate(Interval estimate)
createTimeEstimate()
,
TaskPlanFactory.createInterval(String)
Interval createTimeEstimate()
getTimeEstimate()
,
destroyTimeEstimate()
void destroyTimeEstimate()
AssignmentInstructions getAssignmentInstructions()
createAssignmentInstructions()
,
destroyAssignmentInstructions()
void setAssignmentInstructions(AssignmentInstructions instructions)
createAssignmentInstructions()
,
TaskPlanFactory.createAssignmentInstructions()
AssignmentInstructions createAssignmentInstructions()
destroyAssignmentInstructions()
void destroyAssignmentInstructions()
StepAction getStepAction(String name) throws UnknownObjectException
name
-
UnknownObjectException
AssignAction getAssignAction(String name) throws UnknownObjectException
UnknownObjectException
AssignAction addAssignAction(String name)
name
- The name of the action to add (must be unique among all
actions of any type in this step).ReturnAction getReturnAction(String name) throws UnknownObjectException
UnknownObjectException
ReturnAction addReturnAction(String name)
name
- The name of the action to add (must be unique among all
actions of any type in this step).StepWorkAction getWorkAction(String name) throws UnknownObjectException
UnknownObjectException
StepWorkAction addWorkAction(String name)
name
- The name of the action to add (must be unique among all
actions of any type in this step).
AssignToNextUserAction getAssignToNextUserAction(String name) throws UnknownObjectException
UnknownObjectException
AssignToNextUserAction addAssignToNextUserAction(String name)
name
- The name of the action to add (must be unique among all
actions of any type in this step).
List<ActionConnector> getTargetActionConnectors()
void addActionConnectorToTarget(ActionConnector connector)
connector
- void removeActionConnectorFromTarget(ActionConnector connector)
connector
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |