org.yawlfoundation.yawl.worklet.exception

Class ExletRunner

java.lang.Object

org.yawlfoundation.yawl.worklet.selection.AbstractRunner

org.yawlfoundation.yawl.worklet.exception.ExletRunner

public class ExletRunner
extends AbstractRunner

The ExletRunner class manages an exception handling process. An instance of this class is created for each exception process raised by a case. This class also manages running worklet instances for a 'parent' case when required. The key data member is the RdrConclusion _conclusion, which contains the sequential set of exception handling primitives for this particular handler.

Version:

0.8, 04-09/2006; updated for v4 9/2015

Author:

Michael Adams

Field Summary

Fields inherited from class org.yawlfoundation.yawl.worklet.selection.AbstractRunner

_caseID, _dataString, _ruleNodeId, _ruleType, _wir, _wirID

Constructor Summary

Constructors

Constructor and Description
ExletRunner(java.lang.String caseID, RdrConclusion rdrConc, RuleType xType) This constructor is used when an exception is raised at the case level
ExletRunner(WorkItemRecord wir, RdrConclusion rdrConc, RuleType xType) This constructor is used when an exception is raised at the workitem level

Method Summary

Modifier and Type	Method and Description
void	addWorklet(WorkletRunner runner)
protected void	addWorkletRunners(java.util.Set<WorkletRunner> runners)
void	clearCaseSuspended() called when an action unsuspends the case of this ExletRunner
void	clearSuspendedItems() called when an action unsuspends the item or parent case of this ExletRunner
int	getActionCount()
int	getActionIndex()
Element	getDataForCaseLaunch()
java.lang.String	getNextAction()
java.lang.String	getNextTarget()
java.util.Set<java.lang.String>	getSuspendedItems()
java.lang.String	getTrigger()
Element	getWorkItemDatalist()
Element	getWorkItemUpdatedData()
java.util.Set<WorkletRunner>	getWorkletRunners()
boolean	hasNextAction()
boolean	hasRunningWorklet()
int	incActionIndex()
boolean	isCaseSuspended()
boolean	isItemSuspended()
WorkletRunner	removeWorklet(java.lang.String caseID)
WorkletRunner	removeWorklet(WorkletRunner runner)
void	removeWorklets(java.util.Set<WorkletRunner> toRemove)
java.util.Set<WorkletRunner>	restoreWorkletRunners()
void	setCaseSuspended() called when an action suspends the case of this ExletRunner
void	setData(Element dataElem)
void	setItem(WorkItemRecord item)
void	setItemSuspended() called when an action suspends the workitem of this ExletRunner
void	setSuspendedItems(java.util.Set<WorkItemRecord> items) called when an action suspends the item or parent case of this ExletRunner
void	setTrigger(java.lang.String trigger)
void	unsetItemSuspended() called when an action unsuspends the workitem of this ExletRunner

Methods inherited from class org.yawlfoundation.yawl.worklet.selection.AbstractRunner

fromXNode, getCaseID, getDataListString, getID, getParentWorkItemID, getRuleNodeID, getRuleType, getTaskID, getWir, getWorkItemData, getWorkItemID, setRuleNodeID, toString, toXNode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExletRunner

public ExletRunner(java.lang.String caseID,
                   RdrConclusion rdrConc,
                   RuleType xType)

This constructor is used when an exception is raised at the case level

Parameters:

rdrConc - the RdrConclusion of a rule that represents the handling process

ExletRunner

public ExletRunner(WorkItemRecord wir,
                   RdrConclusion rdrConc,
                   RuleType xType)

This constructor is used when an exception is raised at the workitem level

Method Detail

getNextAction

public java.lang.String getNextAction()

Returns:

the action for the current index from the RdrConclusion

getNextTarget

public java.lang.String getNextTarget()

Returns:

the target for the current index from the RdrConclusion

getActionIndex

public int getActionIndex()

Returns:

the current index in the set of actions

getActionCount

public int getActionCount()

Returns:

the total number of primitives in the conclusion

getSuspendedItems

public java.util.Set<java.lang.String> getSuspendedItems()

Returns:

the list of currently suspended workitems for this runner

setData

public void setData(Element dataElem)

getDataForCaseLaunch

public Element getDataForCaseLaunch()

getWorkItemDatalist

public Element getWorkItemDatalist()

Returns:

the data params for the parent workitem/case

getWorkItemUpdatedData

public Element getWorkItemUpdatedData()

addWorklet

public void addWorklet(WorkletRunner runner)

removeWorklet

public WorkletRunner removeWorklet(WorkletRunner runner)

removeWorklet

public WorkletRunner removeWorklet(java.lang.String caseID)

removeWorklets

public void removeWorklets(java.util.Set<WorkletRunner> toRemove)

hasRunningWorklet

public boolean hasRunningWorklet()

getWorkletRunners

public java.util.Set<WorkletRunner> getWorkletRunners()

addWorkletRunners

protected void addWorkletRunners(java.util.Set<WorkletRunner> runners)

restoreWorkletRunners

public java.util.Set<WorkletRunner> restoreWorkletRunners()

setTrigger

public void setTrigger(java.lang.String trigger)

getTrigger

public java.lang.String getTrigger()

setItem

public void setItem(WorkItemRecord item)

setItemSuspended

public void setItemSuspended()

called when an action suspends the workitem of this ExletRunner

unsetItemSuspended

public void unsetItemSuspended()

called when an action unsuspends the workitem of this ExletRunner

setCaseSuspended

public void setCaseSuspended()

called when an action suspends the case of this ExletRunner

clearCaseSuspended

public void clearCaseSuspended()

called when an action unsuspends the case of this ExletRunner

setSuspendedItems

public void setSuspendedItems(java.util.Set<WorkItemRecord> items)

called when an action suspends the item or parent case of this ExletRunner

clearSuspendedItems

public void clearSuspendedItems()

called when an action unsuspends the item or parent case of this ExletRunner

incActionIndex

public int incActionIndex()

hasNextAction

public boolean hasNextAction()

Returns:

true if there is another action to run in the set

isItemSuspended

public boolean isItemSuspended()

isCaseSuspended

public boolean isCaseSuspended()