org.yawlfoundation.yawl.worklet.support

Class WorkletEventServer

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.Interface_Client

org.yawlfoundation.yawl.worklet.support.WorkletEventServer

public class WorkletEventServer
extends Interface_Client

Announces worklet service events to registered listeners Author: Michael Adams Creation Date: 12/12/2012

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkletEventServer.Event

Constructor Summary

Constructors

Constructor and Description
WorkletEventServer() Constructs a new event server

Method Summary

Modifier and Type	Method and Description
java.lang.String	addListener(java.lang.String uri) Adds a listener to the set of registered listeners
void	announceConstraintPass(java.lang.String caseID, Element caseData, RuleType rType) Announces a case-level exception
void	announceConstraintPass(WorkItemRecord wir, Element caseData, RuleType rType) Announces an item-level exception
void	announceException(java.lang.String caseID, Element caseData, RdrNode node, RuleType rType) Announces a case-level exception
void	announceException(WorkItemRecord wir, Element caseData, RdrNode node, RuleType rType) Announces an item-level exception
void	announceSelection(java.util.Set<WorkletRunner> runners, RdrNode node) Announces a worklet selection
boolean	hasListeners()
java.lang.String	removeListener(java.lang.String uri) Removes a listener to the set of registered listeners
void	shutdownListeners() Announces the worklet service is shutting down

Methods inherited from class org.yawlfoundation.yawl.engine.interfce.Interface_Client

executeGet, executePost, getReply, initPostConnection, prepareParamMap, send, setReadTimeout, stripOuterElement, successful

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkletEventServer

public WorkletEventServer()

Constructs a new event server

Method Detail

hasListeners

public boolean hasListeners()

Returns:

true if the server has at least one registered listener

addListener

public java.lang.String addListener(java.lang.String uri)

Adds a listener to the set of registered listeners

Parameters:

uri - the URI of the listener to add

Returns:

a message describing success or error

removeListener

public java.lang.String removeListener(java.lang.String uri)

Removes a listener to the set of registered listeners

Parameters:

uri - the URI of the listener to remove

Returns:

a message describing success or error

announceException

public void announceException(java.lang.String caseID,
                              Element caseData,
                              RdrNode node,
                              RuleType rType)

Announces a case-level exception

Parameters:

caseID - the id of the case on which the exception was raised

caseData - the current case data used to evaluate the exception

node - the node that evaluated to true

rType - the type of exception raised

announceException

public void announceException(WorkItemRecord wir,
                              Element caseData,
                              RdrNode node,
                              RuleType rType)

Announces an item-level exception

Parameters:

wir - the workitem on which the exception was raised

caseData - the current case data used to evaluate the exception

node - the node that evaluated to true

rType - the type of exception raised

announceConstraintPass

public void announceConstraintPass(java.lang.String caseID,
                                   Element caseData,
                                   RuleType rType)

Announces a case-level exception

Parameters:

caseID - the id of the case on which the exception was raised

caseData - the current case data used to evaluate the exception

rType - the type of exception raised

announceConstraintPass

public void announceConstraintPass(WorkItemRecord wir,
                                   Element caseData,
                                   RuleType rType)

Announces an item-level exception

Parameters:

wir - the workitem on which the exception was raised

caseData - the current case data used to evaluate the exception

rType - the type of exception raised

announceSelection

public void announceSelection(java.util.Set<WorkletRunner> runners,
                              RdrNode node)

Announces a worklet selection

Parameters:

runners - a set of descriptors containing case, workitem, data and raised worklet info

shutdownListeners

public void shutdownListeners()

Announces the worklet service is shutting down