org.yawlfoundation.yawl.engine.interfce
Interface EngineGateway

All Superinterfaces:
Remote
All Known Implementing Classes:
EngineGatewayImpl

public interface EngineGateway
extends Remote

/**

Author:
Lachlan Aldred Date: 15/10/2004 Time: 11:28:22

Method Summary
 String addInterfaceXListener(String observerURI)
           
 String addYAWLService(String serviceStr, String sessionHandle)
           
 String cancelCase(String caseID, String sessionHandle)
           
 String cancelWorkItem(String id, String data, String fail, String sessionHandle)
           
 String changePassword(String password, String sessionHandle)
           
 String checkConnection(String sessionHandle)
           
 String checkConnectionForAdmin(String sessionHandle)
           
 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)
           
 String createNewInstance(String workItemID, String paramValueForMICreation, String sessionHandle)
           
 String deleteAccount(String userName, String sessionHandle)
           
 String describeAllWorkItems(String sessionHandle)
           
 void disableLogging()
           
 boolean enginePersistenceFailure()
          Indicates if the engine has encountered some form of persistence failure in its lifetime.
 String getAccounts(String sessionHandle)
           
 String getAllRunningCases(String sessionHandle)
           
 String getAvailableWorkItemIDs(String sessionHandle)
           
 String getBuildProperties(String sessionHandle)
           
 String getCaseData(String caseID, String sessionHandle)
           
 String getCaseInstanceSummary(String sessionHandle)
           
 String getCasesForSpecification(YSpecificationID specID, String sessionHandle)
           
 String getCaseState(String caseID, String sessionHandle)
           
 String getChildrenOfWorkItem(String workItemID, String sessionHandle)
           
 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 caseID, String sessionHandle)
           
 String getSpecificationList(String sessionHandle)
           
 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)
           
 String getWorkItemsForService(String serviceURI, String sessionHandle)
           
 String getWorkItemsWithIdentifier(String idType, String itemID, String sessionHandle)
           
 String getYAWLServiceDocumentation(String yawlServiceURI, String sessionHandle)
           
 String getYAWLServices(String sessionHandle)
           
 void initBuildProperties(InputStream stream)
           
 String isHibernateStatisticsEnabled(String sessionHandle)
           
 String launchCase(YSpecificationID specID, String caseParams, URI completionObserverURI, String logDataStr, Date expiry, String sessionHandle)
           
 String launchCase(YSpecificationID specID, String caseParams, URI completionObserverURI, String logDataStr, Duration duration, String sessionHandle)
           
 String launchCase(YSpecificationID specID, String caseParams, URI completionObserverURI, String logDataStr, long mSec, String sessionHandle)
           
 String launchCase(YSpecificationID specID, String caseParams, URI completionObserverURI, String logDataStr, String sessionHandle)
           
 String launchCase(YSpecificationID specID, String caseParams, URI completionObserverURI, String caseID, String logDataStr, String sessionHandle)
           
 String loadSpecification(String specification, String sessionHandle)
           
 void notifyServletInitialisationComplete(int maxWaitSeconds)
           
 void registerObserverGateway(ObserverGateway gateway)
           
 String rejectAnnouncedEnabledTask(String itemID, String sessionHandle)
           
 String removeInterfaceXListener(String observerURI)
           
 String removeYAWLService(String serviceURI, String sessionHandle)
           
 String restartWorkItem(String workItemID, String sessionHandle)
           
 String rollbackWorkItem(String workItemID, String sessionHandle)
           
 void setActualFilePath(String path)
           
 void setAllowAdminID(boolean allow)
           
 void setDefaultWorklist(String url)
           
 void setHibernateStatisticsEnabled(boolean enable)
           
 String setHibernateStatisticsEnabled(boolean enabled, String sessionHandle)
           
 void shutdown()
           
 String skipWorkItem(String workItemID, String sessionHandle)
           
 String startWorkItem(String workItemID, String sessionHandle)
           
 String suspendWorkItem(String workItemID, String sessionHandle)
           
 String unloadSpecification(YSpecificationID specID, String sessionHandle)
           
 String unsuspendWorkItem(String workItemID, String sessionHandle)
           
 String updateAccount(String userName, String password, String doco, String sessionHandle)
           
 String updateCaseData(String idStr, String data, String sessionHandle)
           
 String updateWorkItemData(String workItemID, String data, String sessionHandle)
           
 

Method Detail

enginePersistenceFailure

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

Returns:
boolean

registerObserverGateway

void registerObserverGateway(ObserverGateway gateway)
                             throws YAWLException
Throws:
YAWLException

setDefaultWorklist

void setDefaultWorklist(String url)

setAllowAdminID

void setAllowAdminID(boolean allow)

disableLogging

void disableLogging()

setHibernateStatisticsEnabled

void setHibernateStatisticsEnabled(boolean enable)

shutdown

void shutdown()

initBuildProperties

void initBuildProperties(InputStream stream)

notifyServletInitialisationComplete

void notifyServletInitialisationComplete(int maxWaitSeconds)

setActualFilePath

void setActualFilePath(String path)

getAvailableWorkItemIDs

String getAvailableWorkItemIDs(String sessionHandle)
                               throws RemoteException
Parameters:
sessionHandle -
Returns:
the ids of all currently active workitems
Throws:
RemoteException

getWorkItem

String getWorkItem(String workItemID,
                   String sessionHandle)
                   throws RemoteException
Parameters:
workItemID -
sessionHandle -
Returns:
the full workitem record matching the id passed
Throws:
RemoteException

getWorkItemExpiryTime

String getWorkItemExpiryTime(String workItemID,
                             String sessionHandle)
                             throws RemoteException
Throws:
RemoteException

getProcessDefinition

String getProcessDefinition(YSpecificationID specID,
                            String sessionHandle)
                            throws RemoteException
Parameters:
specID -
sessionHandle -
Returns:
the specification matching the id passed
Throws:
RemoteException

suspendWorkItem

String suspendWorkItem(String workItemID,
                       String sessionHandle)
                       throws RemoteException
Throws:
RemoteException

unsuspendWorkItem

String unsuspendWorkItem(String workItemID,
                         String sessionHandle)
                         throws RemoteException
Throws:
RemoteException

rollbackWorkItem

String rollbackWorkItem(String workItemID,
                        String sessionHandle)
                        throws RemoteException
Throws:
RemoteException

completeWorkItem

String completeWorkItem(String workItemID,
                        String data,
                        String logPredicate,
                        boolean force,
                        String sessionHandle)
                        throws RemoteException
Throws:
RemoteException

startWorkItem

String startWorkItem(String workItemID,
                     String sessionHandle)
                     throws RemoteException
Throws:
RemoteException

skipWorkItem

String skipWorkItem(String workItemID,
                    String sessionHandle)
                    throws RemoteException
Throws:
RemoteException

createNewInstance

String createNewInstance(String workItemID,
                         String paramValueForMICreation,
                         String sessionHandle)
                         throws RemoteException
Throws:
RemoteException

describeAllWorkItems

String describeAllWorkItems(String sessionHandle)
                            throws RemoteException
Throws:
RemoteException

getWorkItemsWithIdentifier

String getWorkItemsWithIdentifier(String idType,
                                  String itemID,
                                  String sessionHandle)
                                  throws RemoteException
Throws:
RemoteException

getWorkItemsForService

String getWorkItemsForService(String serviceURI,
                              String sessionHandle)
                              throws RemoteException
Throws:
RemoteException

connect

String connect(String userID,
               String password,
               long timeOutSeconds)
               throws RemoteException
Throws:
RemoteException

checkConnection

String checkConnection(String sessionHandle)
                       throws RemoteException
Throws:
RemoteException

checkConnectionForAdmin

String checkConnectionForAdmin(String sessionHandle)
                               throws RemoteException
Throws:
RemoteException

getTaskInformation

String getTaskInformation(YSpecificationID specificationID,
                          String taskID,
                          String sessionHandle)
                          throws RemoteException
Throws:
RemoteException

checkElegibilityToAddInstances

String checkElegibilityToAddInstances(String workItemID,
                                      String sessionHandle)
                                      throws RemoteException
Throws:
RemoteException

getSpecificationList

String getSpecificationList(String sessionHandle)
                            throws RemoteException
Throws:
RemoteException

getSpecificationDataSchema

String getSpecificationDataSchema(YSpecificationID specID,
                                  String sessionHandle)
                                  throws RemoteException
Throws:
RemoteException

launchCase

String launchCase(YSpecificationID specID,
                  String caseParams,
                  URI completionObserverURI,
                  String caseID,
                  String logDataStr,
                  String sessionHandle)
                  throws RemoteException
Throws:
RemoteException

launchCase

String launchCase(YSpecificationID specID,
                  String caseParams,
                  URI completionObserverURI,
                  String logDataStr,
                  String sessionHandle)
                  throws RemoteException
Throws:
RemoteException

launchCase

String launchCase(YSpecificationID specID,
                  String caseParams,
                  URI completionObserverURI,
                  String logDataStr,
                  long mSec,
                  String sessionHandle)
                  throws RemoteException
Throws:
RemoteException

launchCase

String launchCase(YSpecificationID specID,
                  String caseParams,
                  URI completionObserverURI,
                  String logDataStr,
                  Date expiry,
                  String sessionHandle)
                  throws RemoteException
Throws:
RemoteException

launchCase

String launchCase(YSpecificationID specID,
                  String caseParams,
                  URI completionObserverURI,
                  String logDataStr,
                  Duration duration,
                  String sessionHandle)
                  throws RemoteException
Throws:
RemoteException

getCasesForSpecification

String getCasesForSpecification(YSpecificationID specID,
                                String sessionHandle)
                                throws RemoteException
Throws:
RemoteException

getSpecificationForCase

String getSpecificationForCase(String caseID,
                               String sessionHandle)
                               throws RemoteException
Throws:
RemoteException

getAllRunningCases

String getAllRunningCases(String sessionHandle)
                          throws RemoteException
Throws:
RemoteException

getCaseState

String getCaseState(String caseID,
                    String sessionHandle)
                    throws RemoteException
Throws:
RemoteException

cancelCase

String cancelCase(String caseID,
                  String sessionHandle)
                  throws RemoteException
Throws:
RemoteException

getChildrenOfWorkItem

String getChildrenOfWorkItem(String workItemID,
                             String sessionHandle)
                             throws RemoteException
Throws:
RemoteException

getWorkItemOptions

String getWorkItemOptions(String workItemID,
                          String thisURL,
                          String sessionHandle)
                          throws RemoteException
Throws:
RemoteException

loadSpecification

String loadSpecification(String specification,
                         String sessionHandle)
                         throws RemoteException
Throws:
RemoteException

unloadSpecification

String unloadSpecification(YSpecificationID specID,
                           String sessionHandle)
                           throws RemoteException
Throws:
RemoteException

createAccount

String createAccount(String userName,
                     String password,
                     String doco,
                     String sessionHandle)
                     throws RemoteException
Throws:
RemoteException

updateAccount

String updateAccount(String userName,
                     String password,
                     String doco,
                     String sessionHandle)
                     throws RemoteException
Throws:
RemoteException

getAccounts

String getAccounts(String sessionHandle)
                   throws RemoteException
Throws:
RemoteException

getBuildProperties

String getBuildProperties(String sessionHandle)
                          throws RemoteException
Throws:
RemoteException

getYAWLServices

String getYAWLServices(String sessionHandle)
                       throws RemoteException
Throws:
RemoteException

getYAWLServiceDocumentation

String getYAWLServiceDocumentation(String yawlServiceURI,
                                   String sessionHandle)
                                   throws RemoteException
Throws:
RemoteException

addYAWLService

String addYAWLService(String serviceStr,
                      String sessionHandle)
                      throws RemoteException
Throws:
RemoteException

removeYAWLService

String removeYAWLService(String serviceURI,
                         String sessionHandle)

deleteAccount

String deleteAccount(String userName,
                     String sessionHandle)
                     throws RemoteException
Throws:
RemoteException

changePassword

String changePassword(String password,
                      String sessionHandle)
                      throws RemoteException
Throws:
RemoteException

getClientAccount

String getClientAccount(String userID,
                        String sessionHandle)
                        throws RemoteException
Throws:
RemoteException

getClientPassword

String getClientPassword(String userID,
                         String sessionHandle)
                         throws RemoteException
Throws:
RemoteException

addInterfaceXListener

String addInterfaceXListener(String observerURI)

removeInterfaceXListener

String removeInterfaceXListener(String observerURI)

updateWorkItemData

String updateWorkItemData(String workItemID,
                          String data,
                          String sessionHandle)

updateCaseData

String updateCaseData(String idStr,
                      String data,
                      String sessionHandle)

restartWorkItem

String restartWorkItem(String workItemID,
                       String sessionHandle)
                       throws RemoteException
Throws:
RemoteException

cancelWorkItem

String cancelWorkItem(String id,
                      String data,
                      String fail,
                      String sessionHandle)
                      throws RemoteException
Throws:
RemoteException

getLatestSpecVersion

String getLatestSpecVersion(String id,
                            String sessionHandle)
                            throws RemoteException
Throws:
RemoteException

getMITaskAttributes

String getMITaskAttributes(YSpecificationID specificationID,
                           String taskID,
                           String sessionHandle)
                           throws RemoteException
Throws:
RemoteException

getResourcingSpecs

String getResourcingSpecs(YSpecificationID specificationID,
                          String taskID,
                          String sessionHandle)
                          throws RemoteException
Throws:
RemoteException

getCaseData

String getCaseData(String caseID,
                   String sessionHandle)
                   throws RemoteException
Throws:
RemoteException

getCaseInstanceSummary

String getCaseInstanceSummary(String sessionHandle)
                              throws RemoteException
Throws:
RemoteException

getWorkItemInstanceSummary

String getWorkItemInstanceSummary(String caseID,
                                  String sessionHandle)
                                  throws RemoteException
Throws:
RemoteException

getParameterInstanceSummary

String getParameterInstanceSummary(String caseID,
                                   String itemID,
                                   String sessionHandle)
                                   throws RemoteException
Throws:
RemoteException

rejectAnnouncedEnabledTask

String rejectAnnouncedEnabledTask(String itemID,
                                  String sessionHandle)
                                  throws RemoteException
Throws:
RemoteException

getExternalDBGateways

String getExternalDBGateways(String sessionHandle)
                             throws RemoteException
Throws:
RemoteException

setHibernateStatisticsEnabled

String setHibernateStatisticsEnabled(boolean enabled,
                                     String sessionHandle)

isHibernateStatisticsEnabled

String isHibernateStatisticsEnabled(String sessionHandle)

getHibernateStatistics

String getHibernateStatistics(String sessionHandle)


Copyright © 2004-2012 The YAWL Foundation.