org.yawlfoundation.yawl.procletService

Class ProcletService

java.lang.Object

org.yawlfoundation.yawl.engine.interfce.interfaceB.InterfaceBWebsideController

org.yawlfoundation.yawl.procletService.ProcletService

public class ProcletService
extends InterfaceBWebsideController

Field Summary

Fields inherited from class org.yawlfoundation.yawl.engine.interfce.interfaceB.InterfaceBWebsideController

_ibCache, _interfaceBClient, _logger, _report, engineLogonName, engineLogonPassword, XSD_ANYURI_TYPE, XSD_NAMESPACE, XSD_NCNAME_TYPE, XSD_STRINGTYPE

Method Summary

Modifier and Type	Method and Description
static java.lang.String	changeCaseID(java.lang.String caseID)
static java.lang.String	changeTaskID(java.lang.String taskID)
void	destroy() Receives notification when the environment is being shutdown.
static ProcletService	getInstance()
java.util.List<java.lang.String>	getRunningCaseIDs()
java.util.List<java.lang.String>	getSpecURIsForRunningCases()
void	handleCancelledCaseEvent(java.lang.String caseID) Receives notification from the engine that an active case has been cancelled.
void	handleCancelledWorkItemEvent(WorkItemRecord wir) Receives notification from the engine that an active workitem has been cancelled.
void	handleCompleteCaseEvent(java.lang.String caseID, java.lang.String casedata) Receives notification from the engine that an active case has been completed.
void	handleEnabledWorkItemEvent(WorkItemRecord wir) Receives notification from the engine of an enabled workitem.
java.lang.String	launchCase(java.lang.String classID, java.lang.String data)
static void	main(java.lang.String[] args)

Methods inherited from class org.yawlfoundation.yawl.engine.interfce.interfaceB.InterfaceBWebsideController

checkConnection, checkInWorkItem, checkInWorkItem, checkInWorkItem, checkOut, checkOutAllInstancesOfThisTask, connect, describeRequiredParams, doGet, getAuthenticationConfig, getCachedWorkItem, getChildren, getEngineStoredWorkItem, getIBCache, getModel, getResourcingSpecs, getSpecificationData, getSpecificationData, getSpecificationPrototypesList, getTaskInformation, getTaskInformation, handleCaseResumedEvent, handleCaseSuspendedEvent, handleCaseSuspendingEvent, handleDeadlockedCaseEvent, handleEngineInitialisationCompletedEvent, handleStartCaseEvent, handleTimerExpiryEvent, handleWorkItemStatusChangeEvent, logContactError, prepareReplyRootElement, setEngineLogonName, setEngineLogonPassword, setRemoteAuthenticationDetails, setUpInterfaceBClient, successful

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ProcletService getInstance()

destroy

public void destroy()

Description copied from class: InterfaceBWebsideController

Receives notification when the environment is being shutdown. Override this method to take any necessary finalisation action.

Overrides:

destroy in class InterfaceBWebsideController

handleEnabledWorkItemEvent

public void handleEnabledWorkItemEvent(WorkItemRecord wir)

Description copied from class: InterfaceBWebsideController

Receives notification from the engine of an enabled workitem. Typically, a custom service will implement this method to check out the work item, and process it as appropriate for the service.

Specified by:

handleEnabledWorkItemEvent in class InterfaceBWebsideController

Parameters:

wir - the enabled work item

handleCancelledWorkItemEvent

public void handleCancelledWorkItemEvent(WorkItemRecord wir)

Description copied from class: InterfaceBWebsideController

Receives notification from the engine that an active workitem has been cancelled. A custom service will implement this method to take any cleanup action on a previously checked out workitem.

Specified by:

handleCancelledWorkItemEvent in class InterfaceBWebsideController

Parameters:

wir - the cancelled work item

handleCancelledCaseEvent

public void handleCancelledCaseEvent(java.lang.String caseID)

Description copied from class: InterfaceBWebsideController

Receives notification from the engine that an active case has been cancelled. Override this method to take any necessary action.

Overrides:

handleCancelledCaseEvent in class InterfaceBWebsideController

Parameters:

caseID - the id of the case that has been cancelled

handleCompleteCaseEvent

public void handleCompleteCaseEvent(java.lang.String caseID,
                                    java.lang.String casedata)

Description copied from class: InterfaceBWebsideController

Receives notification from the engine that an active case has been completed. By overriding this method a service can process case completion events as required.

Overrides:

handleCompleteCaseEvent in class InterfaceBWebsideController

Parameters:

caseID - the id of the completed case.

casedata - the set of net-level data for the case when it completes

launchCase

public java.lang.String launchCase(java.lang.String classID,
                                   java.lang.String data)

changeTaskID

public static java.lang.String changeTaskID(java.lang.String taskID)

changeCaseID

public static java.lang.String changeCaseID(java.lang.String caseID)

getSpecURIsForRunningCases

public java.util.List<java.lang.String> getSpecURIsForRunningCases()

getRunningCaseIDs

public java.util.List<java.lang.String> getRunningCaseIDs()

main

public static void main(java.lang.String[] args)