org.yawlfoundation.yawl.worklet.exception

Class ExceptionActions

java.lang.Object

org.yawlfoundation.yawl.worklet.exception.ExceptionActions

public class ExceptionActions
extends java.lang.Object

Author:

Michael Adams

Created/Last Date:

6/01/2016

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExceptionActions(EngineClient client)

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<WorkItemRecord>	getSuspendableWorkItems(java.lang.String scope, java.lang.String id) Retrieves a list of 'suspendable' workitems (ie.
protected java.util.Set<WorkItemRecord>	getSuspendableWorkItems(YSpecificationID id)
protected java.util.Set<WorkItemRecord>	getSuspendableWorkItemsInChain(java.util.Map<java.lang.String,WorkletRunner> runners, java.lang.String caseID) Returns all suspendable workitems in the hierarchy of ancestor cases
protected boolean	suspendAllCases(ExletRunner hr) Suspends all live workitems in all live cases for the specification passed
protected boolean	suspendAncestorCases(ExletRunner runner, java.util.Set<WorkItemRecord> items) Suspends all running worklet cases in the hierarchy of handlers
protected boolean	suspendAncestorCases(java.util.Map<java.lang.String,WorkletRunner> runners, ExletRunner runner) Suspends all running worklet cases in the hierarchy of handlers
protected boolean	suspendCase(ExletRunner hr) Suspends all live workitems in the specified case
protected java.util.Set<WorkItemRecord>	suspendCase(java.lang.String caseID) Suspends all live workitems in the specified case
boolean	suspendWorkItem(WorkItemRecord wir)
protected boolean	suspendWorkItemList(java.util.Set<WorkItemRecord> items) Suspends each workitem in the list of items passed
protected void	unsuspendList(ExletRunner runner) unsuspends all previously suspended workitems in this case and/or spec
protected WorkItemRecord	unsuspendWorkItem(WorkItemRecord wir) Moves a workitem from suspended to its previous status

Methods inherited from class java.lang.Object

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

Constructor Detail

ExceptionActions

protected ExceptionActions(EngineClient client)

Method Detail

suspendWorkItemList

protected boolean suspendWorkItemList(java.util.Set<WorkItemRecord> items)

Suspends each workitem in the list of items passed

Parameters:

items - - items a list of workitems to suspend

Returns:

true if all were successfully suspended

suspendAncestorCases

protected boolean suspendAncestorCases(ExletRunner runner,
                                       java.util.Set<WorkItemRecord> items)

Suspends all running worklet cases in the hierarchy of handlers

Parameters:

runner - - the runner for the child worklet case

getSuspendableWorkItems

protected java.util.Set<WorkItemRecord> getSuspendableWorkItems(YSpecificationID id)

suspendAllCases

protected boolean suspendAllCases(ExletRunner hr)

Suspends all live workitems in all live cases for the specification passed

Parameters:

hr - the HandlerRunner instance with the workitem to suspend

Returns:

a List of the workitems suspended

suspendCase

protected boolean suspendCase(ExletRunner hr)

Suspends all live workitems in the specified case

Parameters:

hr - the HandlerRunner instance with the workitem to suspend

Returns:

a List of the workitems suspended

suspendCase

protected java.util.Set<WorkItemRecord> suspendCase(java.lang.String caseID)

Suspends all live workitems in the specified case

Parameters:

caseID - - the id of the case to suspend

Returns:

true on successful suspend

suspendWorkItem

public boolean suspendWorkItem(WorkItemRecord wir)

getSuspendableWorkItems

protected java.util.Set<WorkItemRecord> getSuspendableWorkItems(java.lang.String scope,
                                                                java.lang.String id)

Retrieves a list of 'suspendable' workitems (ie. enabled, fired or executing) for a specified scope.

Parameters:

scope - - either case (all items in a case) or spec (all items in all case instances of that specification) or task (all workitem instances of that task)

id - - the id of the case/spec/task

Returns:

a list of the requested workitems

getSuspendableWorkItemsInChain

protected java.util.Set<WorkItemRecord> getSuspendableWorkItemsInChain(java.util.Map<java.lang.String,WorkletRunner> runners,
                                                                       java.lang.String caseID)

Returns all suspendable workitems in the hierarchy of ancestor cases

Parameters:

caseID -

Returns:

the list of suspendable workitems

suspendAncestorCases

protected boolean suspendAncestorCases(java.util.Map<java.lang.String,WorkletRunner> runners,
                                       ExletRunner runner)

Suspends all running worklet cases in the hierarchy of handlers

Parameters:

runner - - the runner for the child worklet case

unsuspendWorkItem

protected WorkItemRecord unsuspendWorkItem(WorkItemRecord wir)

Moves a workitem from suspended to its previous status

Parameters:

wir - - the workitem to unsuspend

Returns:

the unsuspended workitem (record)

unsuspendList

protected void unsuspendList(ExletRunner runner)

unsuspends all previously suspended workitems in this case and/or spec