org.yawlfoundation.yawl.engine.interfce
Class EngineGatewayImpl

java.lang.Object
  extended by org.yawlfoundation.yawl.engine.interfce.EngineGatewayImpl
All Implemented Interfaces:
Remote, EngineGateway

public class EngineGatewayImpl
extends Object
implements EngineGateway

This class allows access to all of the engines capabilities using Strings and XML interface to pass information.

Author:
Lachlan Aldred Date: 21/01/2004 Time: 11:58:18, Michael Adams (for v2)

Constructor Summary
EngineGatewayImpl(boolean persist)
          Constructor
EngineGatewayImpl(boolean persist, boolean gatherHbnStats)
          Constructor
 
Method Summary
 String addInterfaceXListener(String listenerURI)
          The following methods are called by an Exception Service via Interface_X
 String addYAWLService(String serviceStr, String sessionHandle)
          Adds a new YAWL service to the engine
 String cancelCase(String caseID, String sessionHandle)
          Cancels a running case.
 String cancelWorkItem(String workItemID, String data, String fail, String sessionHandle)
           
 String changePassword(String password, String sessionHandle)
           
 String checkConnection(String sessionHandle)
           
 String checkConnectionForAdmin(String sessionHandle)
          Deprecated. no longer valid - performs same function as 'checkConnection'
 String checkElegibilityToAddInstances(String workItemID, String sessionHandle)
           
 String completeWorkItem(String workItemID, String data, String logPredicate, boolean force, String sessionHandle)
           
 String connect(String userID, String password, long timeOutSeconds)
           
 String createAccount(String userName, String password, String doco, String sessionHandle)
          Creates a new external client account in the system.
 String createNewInstance(String workItemID, String paramValueForMICreation, String sessionHandle)
          Creates a workitem sibling of of the workitemid param.
 String deleteAccount(String client, String sessionHandle)
          Deprecated. The YAWL Engine no longer maintains users directly
 String describeAllWorkItems(String sessionHandle)
           
 void disableLogging()
          Disables the recording of events in the process logs
 boolean enginePersistenceFailure()
          Indicates if the engine has encountered some form of persistence failure in its lifetime.
 String getAccounts(String sessionHandle)
          Gets the list of external accounts in the system.
 String getAllRunningCases(String sessionHandle)
           
 String getAvailableWorkItemIDs(String sessionHandle)
          Gets a list of the ids of all currently active workitems
 String getBuildProperties(String sessionHandle)
           
 String getCaseData(String caseID, String sessionHandle)
           
 String getCaseInstanceSummary(String sessionHandle)
           
 String getCasesForSpecification(YSpecificationID specID, String sessionHandle)
          Given a process specification id return the cases that are its running instances.
 String getCaseState(String caseID, String sessionHandle)
          This method returns a complex XML message containing the state of a particular case.
 String getChildrenOfWorkItem(String workItemID, String sessionHandle)
          Gets the child work items of a given work item id string.
 String getClientAccount(String userID, String sessionHandle)
           
 String getClientPassword(String userID, String sessionHandle)
           
 String getExternalDBGateways(String sessionHandle)
           
 String getHibernateStatistics(String sessionHandle)
           
 String getLatestSpecVersion(String id, String sessionHandle)
           
 String getMITaskAttributes(YSpecificationID specificationID, String taskID, String sessionHandle)
           
 String getParameterInstanceSummary(String caseID, String itemID, String sessionHandle)
           
 String getProcessDefinition(YSpecificationID specID, String sessionHandle)
           
 String getResourcingSpecs(YSpecificationID specificationID, String taskID, String sessionHandle)
           
 String getSpecificationDataSchema(YSpecificationID specID, String sessionHandle)
           
 String getSpecificationForCase(String caseIDStr, String sessionHandle)
           
 String getSpecificationList(String sessionHandle)
          Gets a listing of
 String getTaskInformation(YSpecificationID specificationID, String taskID, String sessionHandle)
           
 String getWorkItem(String workItemID, String sessionHandle)
           
 String getWorkItemExpiryTime(String workItemID, String sessionHandle)
           
 String getWorkItemInstanceSummary(String caseID, String sessionHandle)
           
 String getWorkItemOptions(String workItemID, String thisURL, String sessionHandle)
          Provides an XML list of options for manipulating a work item.
 String getWorkItemsForService(String serviceURI, String sessionHandle)
           
 String getWorkItemsWithIdentifier(String idType, String itemID, String sessionHandle)
           
 String getYAWLServiceDocumentation(String yawlServiceURI, String sessionHandle)
          Gets the documentation associated with the yawl service
 String getYAWLServices(String sessionHandle)
          Returns an XML list (unrooted) of yawlService elements.
 void initBuildProperties(InputStream stream)
          Loads build properties from the stream (build number, date, version)
 String isHibernateStatisticsEnabled(String sessionHandle)
           
 String launchCase(YSpecificationID specID, String caseParams, URI caseCompletionURI, String logDataStr, Date expiry, String sessionHandle)
           
 String launchCase(YSpecificationID specID, String caseParams, URI caseCompletionURI, String logDataStr, Duration duration, String sessionHandle)
           
 String launchCase(YSpecificationID specID, String caseParams, URI caseCompletionURI, String logDataStr, long mSec, String sessionHandle)
           
 String launchCase(YSpecificationID specID, String caseParams, URI caseCompletionURI, String logDataStr, String sessionHandle)
           
 String launchCase(YSpecificationID specID, String caseParams, URI caseCompletionURI, String caseID, String logDataStr, String sessionHandle)
           
 String loadSpecification(String specificationStr, String sessionHandle)
          Allows the user to load a specificationStr.
 void notifyServletInitialisationComplete(int maxWaitSeconds)
          Triggers the announcement that engine startup is complete.
 void registerObserverGateway(ObserverGateway gateway)
          Registers an external observer gateway with the engine
 String rejectAnnouncedEnabledTask(String itemID, String sessionHandle)
           
 String removeInterfaceXListener(String listenerURI)
           
 String removeYAWLService(String serviceURI, String sessionHandle)
           
 String restartWorkItem(String workItemID, String sessionHandle)
           
 String rollbackWorkItem(String workItemID, String sessionHandle)
           
 void setActualFilePath(String path)
          Sets the actual absolute file location which contains the engine's class file root
 void setAllowAdminID(boolean allow)
          Enables or disables the use of the generic 'admin' user
 void setDefaultWorklist(String url)
          Sets the URL for the 'default' worklist - i.e.
 void setHibernateStatisticsEnabled(boolean enabled)
          Enables or disables the gathering of hibernate statistics
 String setHibernateStatisticsEnabled(boolean enabled, String sessionHandle)
           
 void shutdown()
          Notifies the engine that its servlet is shutting down
 String skipWorkItem(String workItemID, String sessionHandle)
           
 String startWorkItem(String workItemID, String sessionHandle)
           
 String suspendWorkItem(String workItemID, String sessionHandle)
           
 String unloadSpecification(YSpecificationID specID, String sessionHandle)
          Unloads the specification.
 String unsuspendWorkItem(String workItemID, String sessionHandle)
           
 String updateAccount(String userName, String password, String doco, String sessionHandle)
          Creates a new external client account in the system.
 String updateCaseData(String caseID, String data, String sessionHandle)
           
 String updateWorkItemData(String workItemID, String data, String sessionHandle)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EngineGatewayImpl

public EngineGatewayImpl(boolean persist)
                  throws YPersistenceException
Constructor

Parameters:
persist - true if a reference to a persisting engine is required
Throws:
YPersistenceException - if persist is true and a persisting engine is unavailable

EngineGatewayImpl

public EngineGatewayImpl(boolean persist,
                         boolean gatherHbnStats)
                  throws YPersistenceException
Constructor

Parameters:
persist - true if a reference to a persisting engine is required
gatherHbnStats - true to turn on hibernate statistics gathering
Throws:
YPersistenceException - if persist is true and a persisting engine is unavailable
Method Detail

enginePersistenceFailure

public boolean enginePersistenceFailure()
Indicates if the engine has encountered some form of persistence failure in its lifetime.

Specified by:
enginePersistenceFailure in interface EngineGateway
Returns:
whether or not the engine has failed to achieve persistence

registerObserverGateway

public void registerObserverGateway(ObserverGateway gateway)
                             throws YAWLException
Registers an external observer gateway with the engine

Specified by:
registerObserverGateway in interface EngineGateway
Parameters:
gateway - the gateway to register
Throws:
YAWLException - if the observerGateway has a null scheme value.

setDefaultWorklist

public void setDefaultWorklist(String url)
Sets the URL for the 'default' worklist - i.e. the service that will receive task enabled notifications for those tasks that are not explicitly associated with a custom service

Specified by:
setDefaultWorklist in interface EngineGateway
Parameters:
url - the URL of the service that will serve as the default worklist

setAllowAdminID

public void setAllowAdminID(boolean allow)
Enables or disables the use of the generic 'admin' user

Specified by:
setAllowAdminID in interface EngineGateway
Parameters:
allow - true to enable, false to disable

disableLogging

public void disableLogging()
Disables the recording of events in the process logs

Specified by:
disableLogging in interface EngineGateway

setHibernateStatisticsEnabled

public void setHibernateStatisticsEnabled(boolean enabled)
Enables or disables the gathering of hibernate statistics

Specified by:
setHibernateStatisticsEnabled in interface EngineGateway
Parameters:
enabled - true to enable, false to disable

initBuildProperties

public void initBuildProperties(InputStream stream)
Loads build properties from the stream (build number, date, version)

Specified by:
initBuildProperties in interface EngineGateway
Parameters:
stream - a stream of the file containing the build properties

shutdown

public void shutdown()
Notifies the engine that its servlet is shutting down

Specified by:
shutdown in interface EngineGateway

notifyServletInitialisationComplete

public void notifyServletInitialisationComplete(int maxWaitSeconds)
Triggers the announcement that engine startup is complete. Should only be called from InterfaceB_EngineBasedServer.init()

Specified by:
notifyServletInitialisationComplete in interface EngineGateway
Parameters:
maxWaitSeconds - the maximum seconds to wait for services to be contactable

setActualFilePath

public void setActualFilePath(String path)
Sets the actual absolute file location which contains the engine's class file root

Specified by:
setActualFilePath in interface EngineGateway
Parameters:
path - the file path

getAvailableWorkItemIDs

public String getAvailableWorkItemIDs(String sessionHandle)
                               throws RemoteException
Gets a list of the ids of all currently active workitems

Specified by:
getAvailableWorkItemIDs in interface EngineGateway
Parameters:
sessionHandle - a valid session handle
Returns:
a list of the ids
Throws:
RemoteException

getWorkItem

public String getWorkItem(String workItemID,
                          String sessionHandle)
                   throws RemoteException
Specified by:
getWorkItem in interface EngineGateway
Parameters:
workItemID -
sessionHandle -
Returns:
the full work item record of the workitem with the id passed
Throws:
RemoteException

getWorkItemExpiryTime

public String getWorkItemExpiryTime(String workItemID,
                                    String sessionHandle)
                             throws RemoteException
Specified by:
getWorkItemExpiryTime in interface EngineGateway
Throws:
RemoteException

getProcessDefinition

public String getProcessDefinition(YSpecificationID specID,
                                   String sessionHandle)
                            throws RemoteException
Specified by:
getProcessDefinition in interface EngineGateway
Parameters:
specID - the specification (process definition id)
sessionHandle - the sessionhandle
Returns:
a string version of the process definition
Throws:
RemoteException

getSpecificationDataSchema

public String getSpecificationDataSchema(YSpecificationID specID,
                                         String sessionHandle)
                                  throws RemoteException
Specified by:
getSpecificationDataSchema in interface EngineGateway
Throws:
RemoteException

suspendWorkItem

public String suspendWorkItem(String workItemID,
                              String sessionHandle)
                       throws RemoteException
Specified by:
suspendWorkItem in interface EngineGateway
Parameters:
workItemID -
sessionHandle -
Returns:
the suspended workitem record
Throws:
RemoteException

unsuspendWorkItem

public String unsuspendWorkItem(String workItemID,
                                String sessionHandle)
                         throws RemoteException
Specified by:
unsuspendWorkItem in interface EngineGateway
Parameters:
workItemID -
sessionHandle -
Returns:
the resumed workitem record
Throws:
RemoteException

rollbackWorkItem

public String rollbackWorkItem(String workItemID,
                               String sessionHandle)
                        throws RemoteException
Specified by:
rollbackWorkItem in interface EngineGateway
Parameters:
workItemID -
sessionHandle -
Returns:
the rooled back work item record
Throws:
RemoteException

completeWorkItem

public String completeWorkItem(String workItemID,
                               String data,
                               String logPredicate,
                               boolean force,
                               String sessionHandle)
                        throws RemoteException
Specified by:
completeWorkItem in interface EngineGateway
Parameters:
workItemID - work item id
data - data
logPredicate - a pre-parsed configurable logging string
sessionHandle - sessionhandle
Returns:
result XML message.
Throws:
RemoteException - if used in RMI mode

startWorkItem

public String startWorkItem(String workItemID,
                            String sessionHandle)
                     throws RemoteException
Specified by:
startWorkItem in interface EngineGateway
Parameters:
workItemID -
sessionHandle -
Returns:
the started child workitem
Throws:
RemoteException

skipWorkItem

public String skipWorkItem(String workItemID,
                           String sessionHandle)
                    throws RemoteException
Specified by:
skipWorkItem in interface EngineGateway
Parameters:
workItemID -
sessionHandle -
Returns:
the skipped work item record
Throws:
RemoteException

createNewInstance

public String createNewInstance(String workItemID,
                                String paramValueForMICreation,
                                String sessionHandle)
                         throws RemoteException
Creates a workitem sibling of of the workitemid param. It will only do this if: 1) the task for workItemID is multi-instance, 2) and if the task for workItemID is busy 2) and if the task for workItemID allows dynamic instance creation, 3) and if the number of instances has no yet reached max instances.

Specified by:
createNewInstance in interface EngineGateway
Parameters:
workItemID - the id of an existing instance to which to add a new instance
paramValueForMICreation - the data needed to create the new instance
sessionHandle - session handle
Returns:
an xml message indicating result.
Throws:
RemoteException

describeAllWorkItems

public String describeAllWorkItems(String sessionHandle)
                            throws RemoteException
Specified by:
describeAllWorkItems in interface EngineGateway
Parameters:
sessionHandle -
Returns:
a description (record) of all currently active workitems
Throws:
RemoteException

getWorkItemsWithIdentifier

public String getWorkItemsWithIdentifier(String idType,
                                         String itemID,
                                         String sessionHandle)
                                  throws RemoteException
Specified by:
getWorkItemsWithIdentifier in interface EngineGateway
Throws:
RemoteException

getWorkItemsForService

public String getWorkItemsForService(String serviceURI,
                                     String sessionHandle)
                              throws RemoteException
Specified by:
getWorkItemsForService in interface EngineGateway
Throws:
RemoteException

connect

public String connect(String userID,
                      String password,
                      long timeOutSeconds)
               throws RemoteException
Specified by:
connect in interface EngineGateway
Parameters:
userID -
password -
Returns:
a sessionhandle
Throws:
RemoteException

checkConnection

public String checkConnection(String sessionHandle)
                       throws RemoteException
Specified by:
checkConnection in interface EngineGateway
Parameters:
sessionHandle -
Returns:
'true' if the connection is valid
Throws:
RemoteException

checkConnectionForAdmin

public String checkConnectionForAdmin(String sessionHandle)
Deprecated. no longer valid - performs same function as 'checkConnection'

Specified by:
checkConnectionForAdmin in interface EngineGateway
Parameters:
sessionHandle -
Returns:
either "" or "..."

getTaskInformation

public String getTaskInformation(YSpecificationID specificationID,
                                 String taskID,
                                 String sessionHandle)
                          throws RemoteException
Specified by:
getTaskInformation in interface EngineGateway
Parameters:
specificationID -
taskID -
sessionHandle -
Returns:
a task information record
Throws:
RemoteException

checkElegibilityToAddInstances

public String checkElegibilityToAddInstances(String workItemID,
                                             String sessionHandle)
Specified by:
checkElegibilityToAddInstances in interface EngineGateway
Parameters:
workItemID -
sessionHandle -
Returns:
either "<success/>" or <failure><reason>...</...>

getSpecificationList

public String getSpecificationList(String sessionHandle)
                            throws RemoteException
Gets a listing of

Specified by:
getSpecificationList in interface EngineGateway
Parameters:
sessionHandle -
Returns:
a list of currently loaded specifications
Throws:
RemoteException

launchCase

public String launchCase(YSpecificationID specID,
                         String caseParams,
                         URI caseCompletionURI,
                         String caseID,
                         String logDataStr,
                         String sessionHandle)
Specified by:
launchCase in interface EngineGateway
Parameters:
specID - specID
caseParams - format <data>[InputParam]*</data> where InputParam == <varName>var value</varName>
caseID - caseID
sessionHandle -
Returns:
the case id of the launched case, or a diagnostic msg.

launchCase

public String launchCase(YSpecificationID specID,
                         String caseParams,
                         URI caseCompletionURI,
                         String logDataStr,
                         String sessionHandle)
Specified by:
launchCase in interface EngineGateway
Parameters:
specID - specID
caseParams - format <data>[InputParam]*</data> where InputParam == <varName>var value</varName>
sessionHandle -
Returns:
the case id of the launched case, or a diagnostic msg.

launchCase

public String launchCase(YSpecificationID specID,
                         String caseParams,
                         URI caseCompletionURI,
                         String logDataStr,
                         long mSec,
                         String sessionHandle)
Specified by:
launchCase in interface EngineGateway
Parameters:
specID - specID
caseParams - format <data>[InputParam]*</data> where InputParam == <varName>var value</varName>
sessionHandle -
Returns:
success

launchCase

public String launchCase(YSpecificationID specID,
                         String caseParams,
                         URI caseCompletionURI,
                         String logDataStr,
                         Date expiry,
                         String sessionHandle)
Specified by:
launchCase in interface EngineGateway

launchCase

public String launchCase(YSpecificationID specID,
                         String caseParams,
                         URI caseCompletionURI,
                         String logDataStr,
                         Duration duration,
                         String sessionHandle)
Specified by:
launchCase in interface EngineGateway

getCasesForSpecification

public String getCasesForSpecification(YSpecificationID specID,
                                       String sessionHandle)
Given a process specification id return the cases that are its running instances.

Specified by:
getCasesForSpecification in interface EngineGateway
Parameters:
specID - the process specification id string.
sessionHandle - the sessionhandle
Returns:
a XML message containing a set of caseID elements that are run time instances of the process specification with id = specID

getSpecificationForCase

public String getSpecificationForCase(String caseIDStr,
                                      String sessionHandle)
Specified by:
getSpecificationForCase in interface EngineGateway

getAllRunningCases

public String getAllRunningCases(String sessionHandle)
Specified by:
getAllRunningCases in interface EngineGateway

getCaseState

public String getCaseState(String caseID,
                           String sessionHandle)
                    throws RemoteException
This method returns a complex XML message containing the state of a particular case. i.e. every token (identifier) and its position in every condition/ task/ and internal condition.

Specified by:
getCaseState in interface EngineGateway
Parameters:
caseID - case id string
sessionHandle - sessionHandle
Returns:
XML state Message
Throws:
RemoteException

cancelCase

public String cancelCase(String caseID,
                         String sessionHandle)
Cancels a running case.

Specified by:
cancelCase in interface EngineGateway
Parameters:
caseID - the caseID string
sessionHandle - sessionHandle
Returns:
a diagnostic XML message indicating the result of method call.

getBuildProperties

public String getBuildProperties(String sessionHandle)
                          throws RemoteException
Specified by:
getBuildProperties in interface EngineGateway
Throws:
RemoteException

getChildrenOfWorkItem

public String getChildrenOfWorkItem(String workItemID,
                                    String sessionHandle)
                             throws RemoteException
Gets the child work items of a given work item id string.

Specified by:
getChildrenOfWorkItem in interface EngineGateway
Parameters:
workItemID -
sessionHandle -
Returns:
an XML list of elements that describe each child work item.
Throws:
RemoteException

getWorkItemOptions

public String getWorkItemOptions(String workItemID,
                                 String thisURL,
                                 String sessionHandle)
Provides an XML list of options for manipulating a work item. Uses the REST philosophy of showing what you can do with a work item and provides some links to further manipulate the work item.

Specified by:
getWorkItemOptions in interface EngineGateway
Parameters:
workItemID - work item id string
thisURL - the url of the engine interface B server (i think).
sessionHandle - the sesssion handle
Returns:
a REST style list of options to change the work item under question.

loadSpecification

public String loadSpecification(String specificationStr,
                                String sessionHandle)
Allows the user to load a specificationStr.

Specified by:
loadSpecification in interface EngineGateway
Parameters:
specificationStr - a YAWL schema compliant process specificationStr in its entirety, in string format.
sessionHandle - a session handle
Returns:
a diagnostic XML message indicating the result of loading the specificationStr.

unloadSpecification

public String unloadSpecification(YSpecificationID specID,
                                  String sessionHandle)
Unloads the specification.

Specified by:
unloadSpecification in interface EngineGateway
Parameters:
specID - the specification id string
sessionHandle - session handle
Returns:
an XML message indicating the result of the operation.

createAccount

public String createAccount(String userName,
                            String password,
                            String doco,
                            String sessionHandle)
Creates a new external client account in the system.

Specified by:
createAccount in interface EngineGateway
Parameters:
userName - the name of the user
password - the users elected password.
doco - some descriptive text about the account
sessionHandle -
Returns:
diagnostic XML message.

updateAccount

public String updateAccount(String userName,
                            String password,
                            String doco,
                            String sessionHandle)
Creates a new external client account in the system.

Specified by:
updateAccount in interface EngineGateway
Parameters:
userName - the name of the user
password - the users elected password.
doco - some descriptive text about the account
sessionHandle -
Returns:
diagnostic XML message.

getAccounts

public String getAccounts(String sessionHandle)
Gets the list of external accounts in the system.

Specified by:
getAccounts in interface EngineGateway
Parameters:
sessionHandle - session handle
Returns:
an XML message showing each user in the system.

getYAWLServices

public String getYAWLServices(String sessionHandle)
Returns an XML list (unrooted) of yawlService elements.

Specified by:
getYAWLServices in interface EngineGateway
Parameters:
sessionHandle -
Returns:
either "" or "..."

getYAWLServiceDocumentation

public String getYAWLServiceDocumentation(String yawlServiceURI,
                                          String sessionHandle)
Gets the documentation associated with the yawl service

Specified by:
getYAWLServiceDocumentation in interface EngineGateway
Parameters:
yawlServiceURI -
sessionHandle -
Returns:
doco as xml (if any) else failure message

addYAWLService

public String addYAWLService(String serviceStr,
                             String sessionHandle)
Adds a new YAWL service to the engine

Specified by:
addYAWLService in interface EngineGateway
Parameters:
serviceStr - an XML message containing the YAWL service details.
sessionHandle - the session handle
Returns:
diagnostic XML message.

removeYAWLService

public String removeYAWLService(String serviceURI,
                                String sessionHandle)
Specified by:
removeYAWLService in interface EngineGateway

deleteAccount

public String deleteAccount(String client,
                            String sessionHandle)
                     throws RemoteException
Deprecated. The YAWL Engine no longer maintains users directly

Specified by:
deleteAccount in interface EngineGateway
Parameters:
client -
sessionHandle -
Returns:
a success or failure message
Throws:
RemoteException

changePassword

public String changePassword(String password,
                             String sessionHandle)
                      throws RemoteException
Specified by:
changePassword in interface EngineGateway
Throws:
RemoteException

getClientPassword

public String getClientPassword(String userID,
                                String sessionHandle)
                         throws RemoteException
Specified by:
getClientPassword in interface EngineGateway
Throws:
RemoteException

getClientAccount

public String getClientAccount(String userID,
                               String sessionHandle)
                        throws RemoteException
Specified by:
getClientAccount in interface EngineGateway
Throws:
RemoteException

addInterfaceXListener

public String addInterfaceXListener(String listenerURI)
The following methods are called by an Exception Service via Interface_X

Specified by:
addInterfaceXListener in interface EngineGateway

removeInterfaceXListener

public String removeInterfaceXListener(String listenerURI)
Specified by:
removeInterfaceXListener in interface EngineGateway

updateWorkItemData

public String updateWorkItemData(String workItemID,
                                 String data,
                                 String sessionHandle)
Specified by:
updateWorkItemData in interface EngineGateway

updateCaseData

public String updateCaseData(String caseID,
                             String data,
                             String sessionHandle)
Specified by:
updateCaseData in interface EngineGateway

restartWorkItem

public String restartWorkItem(String workItemID,
                              String sessionHandle)
                       throws RemoteException
Specified by:
restartWorkItem in interface EngineGateway
Throws:
RemoteException

cancelWorkItem

public String cancelWorkItem(String workItemID,
                             String data,
                             String fail,
                             String sessionHandle)
                      throws RemoteException
Specified by:
cancelWorkItem in interface EngineGateway
Throws:
RemoteException

getLatestSpecVersion

public String getLatestSpecVersion(String id,
                                   String sessionHandle)
                            throws RemoteException
Specified by:
getLatestSpecVersion in interface EngineGateway
Throws:
RemoteException

getMITaskAttributes

public String getMITaskAttributes(YSpecificationID specificationID,
                                  String taskID,
                                  String sessionHandle)
                           throws RemoteException
Specified by:
getMITaskAttributes in interface EngineGateway
Parameters:
specificationID -
taskID -
sessionHandle -
Returns:
the multiple instance task attributes for the taskid passed
Throws:
RemoteException

getResourcingSpecs

public String getResourcingSpecs(YSpecificationID specificationID,
                                 String taskID,
                                 String sessionHandle)
                          throws RemoteException
Specified by:
getResourcingSpecs in interface EngineGateway
Throws:
RemoteException

getCaseData

public String getCaseData(String caseID,
                          String sessionHandle)
                   throws RemoteException
Specified by:
getCaseData in interface EngineGateway
Throws:
RemoteException

getCaseInstanceSummary

public String getCaseInstanceSummary(String sessionHandle)
                              throws RemoteException
Specified by:
getCaseInstanceSummary in interface EngineGateway
Throws:
RemoteException

getWorkItemInstanceSummary

public String getWorkItemInstanceSummary(String caseID,
                                         String sessionHandle)
                                  throws RemoteException
Specified by:
getWorkItemInstanceSummary in interface EngineGateway
Throws:
RemoteException

getParameterInstanceSummary

public String getParameterInstanceSummary(String caseID,
                                          String itemID,
                                          String sessionHandle)
                                   throws RemoteException
Specified by:
getParameterInstanceSummary in interface EngineGateway
Throws:
RemoteException

rejectAnnouncedEnabledTask

public String rejectAnnouncedEnabledTask(String itemID,
                                         String sessionHandle)
                                  throws RemoteException
Specified by:
rejectAnnouncedEnabledTask in interface EngineGateway
Throws:
RemoteException

getExternalDBGateways

public String getExternalDBGateways(String sessionHandle)
                             throws RemoteException
Specified by:
getExternalDBGateways in interface EngineGateway
Throws:
RemoteException

setHibernateStatisticsEnabled

public String setHibernateStatisticsEnabled(boolean enabled,
                                            String sessionHandle)
Specified by:
setHibernateStatisticsEnabled in interface EngineGateway

isHibernateStatisticsEnabled

public String isHibernateStatisticsEnabled(String sessionHandle)
Specified by:
isHibernateStatisticsEnabled in interface EngineGateway

getHibernateStatistics

public String getHibernateStatistics(String sessionHandle)
Specified by:
getHibernateStatistics in interface EngineGateway


Copyright © 2004-2012 The YAWL Foundation.