com.edorasware.cmmn.model.structure

Class HumanTask

java.lang.Object

com.edorasware.cmmn.model.structure.PlanItem

com.edorasware.cmmn.model.structure.Task

com.edorasware.cmmn.model.structure.HumanTask

public class HumanTask
extends Task

The combination of a PlanItem and its associated THumanTask definition.

<p>Do not rename this class. The name is part of public API. Moving the class to a different package, however, is possible.</p>

Nested Class Summary

Nested classes/interfaces inherited from class com.edorasware.cmmn.model.structure.Task

Task.ParamEntry

Constructor Summary

Constructors

Constructor and Description
HumanTask(PlannableItem plannableItem, Stage parent, Integer instanceId) Construct a human task.

Method Summary

Modifier and Type	Method and Description
PlanItemAction	createPlanItemAction(TransitionData transitionData, EvaluationListeners evaluationListeners) <p>Create an action object for the current state of this plan item.
String	getClientRef() Default implementation returning null.
String	getIdVariableName()
List<Task.ParamEntry>	getInputMap()
List<Task.ParamEntry>	getOutputMap()
String	getPlanItemTypeShort()
THumanTask	getTHumanTask() Typed getter for the generic tPlanItemDefinition property.
void	setClientRef(String clientRef)

Methods inherited from class com.edorasware.cmmn.model.structure.PlanItem

applyVisitor, getActionDescription, getActionName, getActionName, getActivationTime, getActiveChildrenCount, getActiveCount, getActiveCountInStage, getArmedEntrySentries, getArmedExitSentries, getAvailableChildrenCount, getAvailableCount, getAvailableCountInStage, getCasePlanModel, getChildInstanceCount, getClientId, getCompletedChildrenCount, getCompletedCount, getCompletedCountInStage, getCustomAttribute, getCustomState, getCustomState, getDeferredEntrySentries, getDeferredExitSentries, getDescription, getDisabledChildrenCount, getDisabledCount, getDisabledCountInStage, getEnabledChildrenCount, getEnabledCount, getEnabledCountInStage, getExtensionType, getId, getIndexInStage, getInstanceCount, getInstanceCountInStage, getInstanceId, getInstanceIntId, getLastPlanItemTransition, getName, getName, getName, getNewPlanItemData, getParent, getParentInstanceId, getPlannableItem, getState, getTerminatedChildrenCount, getTerminatedCount, getTerminatedCountInStage, getTPlanItemDefinition, getTriggeredChildrenCount, getTriggeredCount, getTriggeredCountInStage, getTriggeredExitSentries, handlePlanItemTransition, isActionHidden, isArmed, isBlocking, isCompletionNeutral, isManualActivation, isNonBlockingComplete, isOfSameHierarchy, isPending, isPreActivation, isRepetition, isRequired, isSemiTerminal, isTerminal, isTriggeredExitSentry, isWaitingOnChildren, isWaitingOnChildren, setClientId, setCustomState, setCustomState, setState, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HumanTask

public HumanTask(PlannableItem plannableItem,
                 Stage parent,
                 Integer instanceId)

Construct a human task. The human task is represented by plannableItem. The human task is created with the given parent stage as parent.

Parameters:

plannableItem - the plannable item

parent - the parent stage

instanceId - the instance id

Method Detail

setClientRef

public void setClientRef(String clientRef)

Parameters:

clientRef - the client reference

getClientRef

public String getClientRef()

Description copied from class: PlanItem

Default implementation returning null.

Overrides:

getClientRef in class PlanItem

Returns:

the client reference

getPlanItemTypeShort

public String getPlanItemTypeShort()

Overrides:

getPlanItemTypeShort in class PlanItem

createPlanItemAction

public PlanItemAction createPlanItemAction(TransitionData transitionData,
                                           EvaluationListeners evaluationListeners)

Description copied from class: PlanItem

<p>Create an action object for the current state of this plan item. For example, a user event listener in state Available should return an action triggering the 'occur' transition.</p> <p>These actions won’t be immediately executed. They are used to render appropriate GUI elements triggering the action based on the user clicking the action button.</p>

Overrides:

createPlanItemAction in class Task

Parameters:

transitionData - optional evaluation context.

evaluationListeners - the call-backs used to evaluate run-time action name expressions.

Returns:

the action object for the current state of the plan item. The default implementation returns null.

getInputMap

public List<Task.ParamEntry> getInputMap()

Specified by:

getInputMap in class Task

getOutputMap

public List<Task.ParamEntry> getOutputMap()

Specified by:

getOutputMap in class Task

getIdVariableName

public String getIdVariableName()

Specified by:

getIdVariableName in class Task

getTHumanTask

public THumanTask getTHumanTask()

Typed getter for the generic tPlanItemDefinition property.

Returns:

the human task