org.yawlfoundation.yawl.engine.interfce.interfaceX

Interface ExceptionGateway

All Known Implementing Classes:

InterfaceX_EngineSideClient

public interface ExceptionGateway

Interface to be implemented by classes which register with the engine to receive notifications of (i) the occurrence of process exceptions and (ii) possible process 'points' to be checked for exceptions.

Author:

Michael Adams 04/07/2006 Based heavily on the ObserverGateway interface writtem by Andrew Hastie

Method Summary

Modifier and Type	Method and Description
void	announceCaseCancellation(java.lang.String caseID) Announced by the engine when a case has been cancelled
void	announceCheckCaseConstraints(YSpecificationID specID, java.lang.String caseID, java.lang.String data, boolean preCheck) Announced by the engine when a case begins or completes to allow for the checking of pre & post constraints.
void	announceCheckWorkItemConstraints(YWorkItem item, Document data, boolean preCheck) Announced by the engine when a new workitem gets enabled to allow for the checking of pre & post constraints.
void	announceConstraintViolation(YWorkItem item) FOR FUTURE IMPLEMENTATION
void	announceTimeOut(YWorkItem item, java.util.List taskList) Announced by the engine when a workitem has reached a deadline.
void	announceWorkitemAbort(YWorkItem item) Announced by the engine when a work item has been checked out and then declined (returned) by a service (before completion)
java.lang.String	getScheme()
void	shutdown() Called when the Engine is shutdown (servlet destroyed); the listener should to do its own finalisation processing

Method Detail

getScheme

java.lang.String getScheme()

announceCheckWorkItemConstraints

void announceCheckWorkItemConstraints(YWorkItem item,
                                      Document data,
                                      boolean preCheck)

Announced by the engine when a new workitem gets enabled to allow for the checking of pre & post constraints.

Parameters:

item - - the enabled workitem

data - - the workitem's data

preCheck - - true if before item execution, false if after

announceCheckCaseConstraints

void announceCheckCaseConstraints(YSpecificationID specID,
                                  java.lang.String caseID,
                                  java.lang.String data,
                                  boolean preCheck)

Announced by the engine when a case begins or completes to allow for the checking of pre & post constraints.

Parameters:

specID - - the id of the specfication of which the case is an instance

caseID - - the id of the case

data - - the case's data

preCheck - - true if before item execution, false if after

announceTimeOut

void announceTimeOut(YWorkItem item,
                     java.util.List taskList)

Announced by the engine when a workitem has reached a deadline.

Parameters:

item - - the timed out workitem (associated with the timeService)

taskList - - a list of tasks running in parallel with the timedout workitem

announceCaseCancellation

void announceCaseCancellation(java.lang.String caseID)

Announced by the engine when a case has been cancelled

Parameters:

caseID - - the cancelled case

shutdown

void shutdown()

Called when the Engine is shutdown (servlet destroyed); the listener should to do its own finalisation processing

announceWorkitemAbort

void announceWorkitemAbort(YWorkItem item)

Announced by the engine when a work item has been checked out and then declined (returned) by a service (before completion)

Parameters:

item - the aborted item

announceConstraintViolation

void announceConstraintViolation(YWorkItem item)

FOR FUTURE IMPLEMENTATION