org.yawlfoundation.yawl.engine.interfce.interfaceX

Class InterfaceX_ServiceSideClient

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.Interface_Client

org.yawlfoundation.yawl.engine.interfce.interfaceX.InterfaceX_ServiceSideClient

public class InterfaceX_ServiceSideClient
extends Interface_Client

InterfaceX_ServiceSideClient posts method calls from an exception service to the YAWL engine. This class is a member class of Interface X, which provides an interface between the YAWL Engine and a Custom YAWL Service that manages exception handling at the process level. InterfaceB_EnvironmentBasedClient was used as a template for this class. Schematic of Interface X: | EXCEPTION | INTERFACE X GATEWAY | SERVICE (implements) | | (implements) | | | | +==========+ -----> ENGINE-SIDE ---|--> SERVICE-SIDE -----> +=============+ || YAWL || CLIENT | SERVER || EXCEPTION || || ENGINE || | || SERVICE || +==========+ <----- ENGINE-SIDE <--|--- SERVICE-SIDE <----- +=============+ SERVER | CLIENT |

Version:

0.8, 04/07/2006

Author:

Michael Adams |

Constructor Summary

Constructors

Constructor and Description
InterfaceX_ServiceSideClient(java.lang.String backEndURIStr) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	addInterfaceXListener(java.lang.String listenerURI)
java.lang.String	cancelWorkItem(java.lang.String workItemID, java.lang.String data, boolean fail, java.lang.String sessionHandle)
WorkItemRecord	continueWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	forceCompleteWorkItem(WorkItemRecord wir, Element data, java.lang.String sessionHandle)
java.lang.String	removeInterfaceXListener(java.lang.String listenerURI)
java.lang.String	restartWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	startWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
WorkItemRecord	unsuspendWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	updateCaseData(java.lang.String caseID, Element data, java.lang.String sessionHandle)
java.lang.String	updateWorkItemData(WorkItemRecord wir, Element data, java.lang.String sessionHandle)

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

InterfaceX_ServiceSideClient

public InterfaceX_ServiceSideClient(java.lang.String backEndURIStr)

Constructor.

Parameters:

backEndURIStr - the back end uri of where to find the engine. A default deployment this value is http://localhost:8080/yawl/ix

Method Detail

addInterfaceXListener

public java.lang.String addInterfaceXListener(java.lang.String listenerURI)
                                       throws java.io.IOException

Throws:

java.io.IOException

removeInterfaceXListener

public java.lang.String removeInterfaceXListener(java.lang.String listenerURI)
                                          throws java.io.IOException

Throws:

java.io.IOException

updateWorkItemData

public java.lang.String updateWorkItemData(WorkItemRecord wir,
                                           Element data,
                                           java.lang.String sessionHandle)
                                    throws java.io.IOException

Throws:

java.io.IOException

updateCaseData

public java.lang.String updateCaseData(java.lang.String caseID,
                                       Element data,
                                       java.lang.String sessionHandle)
                                throws java.io.IOException

Throws:

java.io.IOException

forceCompleteWorkItem

public java.lang.String forceCompleteWorkItem(WorkItemRecord wir,
                                              Element data,
                                              java.lang.String sessionHandle)
                                       throws java.io.IOException

Throws:

java.io.IOException

continueWorkItem

public WorkItemRecord continueWorkItem(java.lang.String workItemID,
                                       java.lang.String sessionHandle)
                                throws java.io.IOException

Throws:

java.io.IOException

unsuspendWorkItem

public WorkItemRecord unsuspendWorkItem(java.lang.String workItemID,
                                        java.lang.String sessionHandle)
                                 throws java.io.IOException

Throws:

java.io.IOException

restartWorkItem

public java.lang.String restartWorkItem(java.lang.String workItemID,
                                        java.lang.String sessionHandle)
                                 throws java.io.IOException

Throws:

java.io.IOException

startWorkItem

public java.lang.String startWorkItem(java.lang.String workItemID,
                                      java.lang.String sessionHandle)
                               throws java.io.IOException

Throws:

java.io.IOException

cancelWorkItem

public java.lang.String cancelWorkItem(java.lang.String workItemID,
                                       java.lang.String data,
                                       boolean fail,
                                       java.lang.String sessionHandle)
                                throws java.io.IOException

Throws:

java.io.IOException