com.edorasware.cmmn.model.structure

Class UserEvent

java.lang.Object

com.edorasware.cmmn.model.structure.PlanItem

com.edorasware.cmmn.model.structure.EventListener

com.edorasware.cmmn.model.structure.UserEvent

public class UserEvent
extends EventListener

The combination of a UserEvent and its associated TUserEvent 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>

Constructor Summary

Constructors

Constructor and Description
UserEvent(PlannableItem plannableItem, Stage parent, Integer instanceId) Construct a user event listener.

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	getPlanItemTypeShort()
boolean	isAutoCompleteStage() Get the value of the 'type' custom property configured on the event listener (optional) and compare it to 'autoComplete'.
boolean	isForceVisibility()

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

evaluateEntryCriteria, evaluateExitCriteria, isArmed, isRepetition

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, getClientRef, 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, isBlocking, isCompletionNeutral, isManualActivation, isNonBlockingComplete, isOfSameHierarchy, isPending, isPreActivation, 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

UserEvent

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

Construct a user event listener. The user event listener is represented by plannableItem. The user event listener is created with the given parent stage as parent.

Parameters:

plannableItem - the plannable item

parent - the parent stage

instanceId - the instance id

Method Detail

isAutoCompleteStage

public boolean isAutoCompleteStage()

Get the value of the 'type' custom property configured on the event listener (optional) and compare it to 'autoComplete'. If true this user event listener implements the stage auto completion functionality (see https://jira.edorasware.com/browse/CLD-7776).

isForceVisibility

public boolean isForceVisibility()

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 EventListener

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.