org.yawlfoundation.yawl.engine.interfce

Interface EngineGateway

All Superinterfaces:

java.rmi.Remote

All Known Implementing Classes:

EngineGatewayImpl

public interface EngineGateway
extends java.rmi.Remote

/**

Author:

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	addInterfaceXListener(java.lang.String observerURI)
java.lang.String	addYAWLService(java.lang.String serviceStr, java.lang.String sessionHandle)
java.lang.String	cancelCase(java.lang.String caseID, java.lang.String sessionHandle)
java.lang.String	cancelWorkItem(java.lang.String id, java.lang.String data, java.lang.String fail, java.lang.String sessionHandle)
java.lang.String	changePassword(java.lang.String password, java.lang.String sessionHandle)
java.lang.String	checkConnection(java.lang.String sessionHandle)
java.lang.String	checkConnectionForAdmin(java.lang.String sessionHandle)
java.lang.String	checkElegibilityToAddInstances(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	completeWorkItem(java.lang.String workItemID, java.lang.String data, java.lang.String logPredicate, boolean force, java.lang.String sessionHandle)
java.lang.String	connect(java.lang.String userID, java.lang.String password, long timeOutSeconds)
java.lang.String	createAccount(java.lang.String userName, java.lang.String password, java.lang.String doco, java.lang.String sessionHandle)
java.lang.String	createNewInstance(java.lang.String workItemID, java.lang.String paramValueForMICreation, java.lang.String sessionHandle)
java.lang.String	deleteAccount(java.lang.String userName, java.lang.String sessionHandle)
java.lang.String	demote(java.lang.String sessionHandle)
java.lang.String	describeAllWorkItems(java.lang.String sessionHandle)
void	disableLogging()
java.lang.String	disconnect(java.lang.String sessionHandle)
boolean	enginePersistenceFailure() Indicates if the engine has encountered some form of persistence failure in its lifetime.
java.lang.String	exportAllCaseStates(java.lang.String sessionHandle)
java.lang.String	exportCaseState(java.lang.String caseID, java.lang.String sessionHandle)
java.lang.String	getAccounts(java.lang.String sessionHandle)
java.lang.String	getAllRunningCases(java.lang.String sessionHandle)
java.lang.String	getAvailableWorkItemIDs(java.lang.String sessionHandle)
java.lang.String	getBuildProperties(java.lang.String sessionHandle)
java.lang.String	getCaseData(java.lang.String caseID, java.lang.String sessionHandle)
java.lang.String	getCaseInstanceSummary(java.lang.String sessionHandle)
java.lang.String	getCasesForSpecification(YSpecificationID specID, java.lang.String sessionHandle)
java.lang.String	getCaseState(java.lang.String caseID, java.lang.String sessionHandle)
java.lang.String	getChildrenOfWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	getClientAccount(java.lang.String userID, java.lang.String sessionHandle)
java.lang.String	getClientPassword(java.lang.String userID, java.lang.String sessionHandle)
java.lang.String	getExternalDBGateways(java.lang.String sessionHandle)
java.lang.String	getHibernateStatistics(java.lang.String sessionHandle)
java.lang.String	getLatestSpecVersion(java.lang.String id, java.lang.String sessionHandle)
java.lang.String	getMITaskAttributes(YSpecificationID specificationID, java.lang.String taskID, java.lang.String sessionHandle)
java.lang.String	getParameterInstanceSummary(java.lang.String caseID, java.lang.String itemID, java.lang.String sessionHandle)
java.lang.String	getProcessDefinition(YSpecificationID specID, java.lang.String sessionHandle)
java.lang.String	getResourcingSpecs(YSpecificationID specificationID, java.lang.String taskID, java.lang.String sessionHandle)
java.lang.String	getSpecificationData(YSpecificationID specID, java.lang.String sessionHandle)
java.lang.String	getSpecificationDataSchema(YSpecificationID specID, java.lang.String sessionHandle)
java.lang.String	getSpecificationForCase(java.lang.String caseID, java.lang.String sessionHandle)
java.lang.String	getSpecificationIDForCase(java.lang.String caseID, java.lang.String sessionHandle)
java.lang.String	getSpecificationList(java.lang.String sessionHandle)
java.lang.String	getStartingDataSnapshot(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	getTaskInformation(YSpecificationID specificationID, java.lang.String taskID, java.lang.String sessionHandle)
java.lang.String	getWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	getWorkItemExpiryTime(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	getWorkItemInstanceSummary(java.lang.String caseID, java.lang.String sessionHandle)
java.lang.String	getWorkItemOptions(java.lang.String workItemID, java.lang.String thisURL, java.lang.String sessionHandle)
java.lang.String	getWorkItemsForService(java.lang.String serviceURI, java.lang.String sessionHandle)
java.lang.String	getWorkItemsWithIdentifier(java.lang.String idType, java.lang.String itemID, java.lang.String sessionHandle)
java.lang.String	getYAWLServiceDocumentation(java.lang.String yawlServiceURI, java.lang.String sessionHandle)
java.lang.String	getYAWLServices(java.lang.String sessionHandle)
java.lang.String	importCases(java.lang.String caseXML, java.lang.String sessionHandle)
void	initBuildProperties(java.io.InputStream stream)
java.lang.String	isHibernateStatisticsEnabled(java.lang.String sessionHandle)
boolean	isRedundantMode()
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseParams, java.net.URI completionObserverURI, java.lang.String logDataStr, java.util.Date expiry, java.lang.String sessionHandle)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseParams, java.net.URI completionObserverURI, java.lang.String logDataStr, javax.xml.datatype.Duration duration, java.lang.String sessionHandle)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseParams, java.net.URI completionObserverURI, java.lang.String logDataStr, long mSec, java.lang.String sessionHandle)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseParams, java.net.URI completionObserverURI, java.lang.String logDataStr, java.lang.String sessionHandle)
java.lang.String	launchCase(YSpecificationID specID, java.lang.String caseParams, java.net.URI completionObserverURI, java.lang.String caseID, java.lang.String logDataStr, java.lang.String sessionHandle)
java.lang.String	loadSpecification(java.lang.String specification, java.lang.String sessionHandle)
void	notifyServletInitialisationComplete(int maxWaitSeconds)
java.lang.String	promote(java.lang.String sessionHandle)
void	registerObserverGateway(ObserverGateway gateway)
java.lang.String	rejectAnnouncedEnabledTask(java.lang.String itemID, java.lang.String sessionHandle)
java.lang.String	removeInterfaceXListener(java.lang.String observerURI)
java.lang.String	removeYAWLService(java.lang.String serviceURI, java.lang.String sessionHandle)
java.lang.String	restartWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	rollbackWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
void	setActualFilePath(java.lang.String path)
void	setAllowAdminID(boolean allow)
void	setDefaultWorklist(java.lang.String url)
void	setHibernateStatisticsEnabled(boolean enable)
java.lang.String	setHibernateStatisticsEnabled(boolean enabled, java.lang.String sessionHandle)
void	shutdown()
java.lang.String	skipWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	startWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	suspendWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	unloadSpecification(YSpecificationID specID, java.lang.String sessionHandle)
java.lang.String	unsuspendWorkItem(java.lang.String workItemID, java.lang.String sessionHandle)
java.lang.String	updateAccount(java.lang.String userName, java.lang.String password, java.lang.String doco, java.lang.String sessionHandle)
java.lang.String	updateCaseData(java.lang.String idStr, java.lang.String data, java.lang.String sessionHandle)
java.lang.String	updateWorkItemData(java.lang.String workItemID, java.lang.String data, java.lang.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(java.lang.String url)

setAllowAdminID

void setAllowAdminID(boolean allow)

disableLogging

void disableLogging()

setHibernateStatisticsEnabled

void setHibernateStatisticsEnabled(boolean enable)

shutdown

void shutdown()

initBuildProperties

void initBuildProperties(java.io.InputStream stream)

notifyServletInitialisationComplete

void notifyServletInitialisationComplete(int maxWaitSeconds)

setActualFilePath

void setActualFilePath(java.lang.String path)

promote

java.lang.String promote(java.lang.String sessionHandle)
                  throws YPersistenceException

Throws:

YPersistenceException

demote

java.lang.String demote(java.lang.String sessionHandle)

isRedundantMode

boolean isRedundantMode()

exportCaseState

java.lang.String exportCaseState(java.lang.String caseID,
                                 java.lang.String sessionHandle)

exportAllCaseStates

java.lang.String exportAllCaseStates(java.lang.String sessionHandle)

importCases

java.lang.String importCases(java.lang.String caseXML,
                             java.lang.String sessionHandle)

getAvailableWorkItemIDs

java.lang.String getAvailableWorkItemIDs(java.lang.String sessionHandle)
                                  throws java.rmi.RemoteException

Parameters:

sessionHandle -

Returns:

the ids of all currently active workitems

Throws:

java.rmi.RemoteException

getWorkItem

java.lang.String getWorkItem(java.lang.String workItemID,
                             java.lang.String sessionHandle)
                      throws java.rmi.RemoteException

Parameters:

workItemID -

sessionHandle -

Returns:

the full workitem record matching the id passed

Throws:

java.rmi.RemoteException

getWorkItemExpiryTime

java.lang.String getWorkItemExpiryTime(java.lang.String workItemID,
                                       java.lang.String sessionHandle)
                                throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getProcessDefinition

java.lang.String getProcessDefinition(YSpecificationID specID,
                                      java.lang.String sessionHandle)
                               throws java.rmi.RemoteException

Parameters:

specID -

sessionHandle -

Returns:

the specification matching the id passed

Throws:

java.rmi.RemoteException

suspendWorkItem

java.lang.String suspendWorkItem(java.lang.String workItemID,
                                 java.lang.String sessionHandle)
                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

unsuspendWorkItem

java.lang.String unsuspendWorkItem(java.lang.String workItemID,
                                   java.lang.String sessionHandle)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

rollbackWorkItem

java.lang.String rollbackWorkItem(java.lang.String workItemID,
                                  java.lang.String sessionHandle)
                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

completeWorkItem

java.lang.String completeWorkItem(java.lang.String workItemID,
                                  java.lang.String data,
                                  java.lang.String logPredicate,
                                  boolean force,
                                  java.lang.String sessionHandle)
                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

startWorkItem

java.lang.String startWorkItem(java.lang.String workItemID,
                               java.lang.String sessionHandle)
                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

skipWorkItem

java.lang.String skipWorkItem(java.lang.String workItemID,
                              java.lang.String sessionHandle)
                       throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getStartingDataSnapshot

java.lang.String getStartingDataSnapshot(java.lang.String workItemID,
                                         java.lang.String sessionHandle)
                                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

createNewInstance

java.lang.String createNewInstance(java.lang.String workItemID,
                                   java.lang.String paramValueForMICreation,
                                   java.lang.String sessionHandle)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

describeAllWorkItems

java.lang.String describeAllWorkItems(java.lang.String sessionHandle)
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getWorkItemsWithIdentifier

java.lang.String getWorkItemsWithIdentifier(java.lang.String idType,
                                            java.lang.String itemID,
                                            java.lang.String sessionHandle)
                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getWorkItemsForService

java.lang.String getWorkItemsForService(java.lang.String serviceURI,
                                        java.lang.String sessionHandle)
                                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

connect

java.lang.String connect(java.lang.String userID,
                         java.lang.String password,
                         long timeOutSeconds)
                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

checkConnection

java.lang.String checkConnection(java.lang.String sessionHandle)
                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

disconnect

java.lang.String disconnect(java.lang.String sessionHandle)
                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

checkConnectionForAdmin

java.lang.String checkConnectionForAdmin(java.lang.String sessionHandle)
                                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getTaskInformation

java.lang.String getTaskInformation(YSpecificationID specificationID,
                                    java.lang.String taskID,
                                    java.lang.String sessionHandle)
                             throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

checkElegibilityToAddInstances

java.lang.String checkElegibilityToAddInstances(java.lang.String workItemID,
                                                java.lang.String sessionHandle)
                                         throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getSpecificationList

java.lang.String getSpecificationList(java.lang.String sessionHandle)
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getSpecificationData

java.lang.String getSpecificationData(YSpecificationID specID,
                                      java.lang.String sessionHandle)
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getSpecificationDataSchema

java.lang.String getSpecificationDataSchema(YSpecificationID specID,
                                            java.lang.String sessionHandle)
                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

launchCase

java.lang.String launchCase(YSpecificationID specID,
                            java.lang.String caseParams,
                            java.net.URI completionObserverURI,
                            java.lang.String caseID,
                            java.lang.String logDataStr,
                            java.lang.String sessionHandle)
                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

launchCase

java.lang.String launchCase(YSpecificationID specID,
                            java.lang.String caseParams,
                            java.net.URI completionObserverURI,
                            java.lang.String logDataStr,
                            java.lang.String sessionHandle)
                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

launchCase

java.lang.String launchCase(YSpecificationID specID,
                            java.lang.String caseParams,
                            java.net.URI completionObserverURI,
                            java.lang.String logDataStr,
                            long mSec,
                            java.lang.String sessionHandle)
                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

launchCase

java.lang.String launchCase(YSpecificationID specID,
                            java.lang.String caseParams,
                            java.net.URI completionObserverURI,
                            java.lang.String logDataStr,
                            java.util.Date expiry,
                            java.lang.String sessionHandle)
                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

launchCase

java.lang.String launchCase(YSpecificationID specID,
                            java.lang.String caseParams,
                            java.net.URI completionObserverURI,
                            java.lang.String logDataStr,
                            javax.xml.datatype.Duration duration,
                            java.lang.String sessionHandle)
                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getCasesForSpecification

java.lang.String getCasesForSpecification(YSpecificationID specID,
                                          java.lang.String sessionHandle)
                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getSpecificationForCase

java.lang.String getSpecificationForCase(java.lang.String caseID,
                                         java.lang.String sessionHandle)
                                  throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getSpecificationIDForCase

java.lang.String getSpecificationIDForCase(java.lang.String caseID,
                                           java.lang.String sessionHandle)
                                    throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getAllRunningCases

java.lang.String getAllRunningCases(java.lang.String sessionHandle)
                             throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getCaseState

java.lang.String getCaseState(java.lang.String caseID,
                              java.lang.String sessionHandle)
                       throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

cancelCase

java.lang.String cancelCase(java.lang.String caseID,
                            java.lang.String sessionHandle)
                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getChildrenOfWorkItem

java.lang.String getChildrenOfWorkItem(java.lang.String workItemID,
                                       java.lang.String sessionHandle)
                                throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getWorkItemOptions

java.lang.String getWorkItemOptions(java.lang.String workItemID,
                                    java.lang.String thisURL,
                                    java.lang.String sessionHandle)
                             throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

loadSpecification

java.lang.String loadSpecification(java.lang.String specification,
                                   java.lang.String sessionHandle)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

unloadSpecification

java.lang.String unloadSpecification(YSpecificationID specID,
                                     java.lang.String sessionHandle)
                              throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

createAccount

java.lang.String createAccount(java.lang.String userName,
                               java.lang.String password,
                               java.lang.String doco,
                               java.lang.String sessionHandle)
                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

updateAccount

java.lang.String updateAccount(java.lang.String userName,
                               java.lang.String password,
                               java.lang.String doco,
                               java.lang.String sessionHandle)
                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getAccounts

java.lang.String getAccounts(java.lang.String sessionHandle)
                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getBuildProperties

java.lang.String getBuildProperties(java.lang.String sessionHandle)
                             throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getYAWLServices

java.lang.String getYAWLServices(java.lang.String sessionHandle)
                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getYAWLServiceDocumentation

java.lang.String getYAWLServiceDocumentation(java.lang.String yawlServiceURI,
                                             java.lang.String sessionHandle)
                                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

addYAWLService

java.lang.String addYAWLService(java.lang.String serviceStr,
                                java.lang.String sessionHandle)
                         throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

removeYAWLService

java.lang.String removeYAWLService(java.lang.String serviceURI,
                                   java.lang.String sessionHandle)

deleteAccount

java.lang.String deleteAccount(java.lang.String userName,
                               java.lang.String sessionHandle)
                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

changePassword

java.lang.String changePassword(java.lang.String password,
                                java.lang.String sessionHandle)
                         throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getClientAccount

java.lang.String getClientAccount(java.lang.String userID,
                                  java.lang.String sessionHandle)
                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getClientPassword

java.lang.String getClientPassword(java.lang.String userID,
                                   java.lang.String sessionHandle)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

addInterfaceXListener

java.lang.String addInterfaceXListener(java.lang.String observerURI)

removeInterfaceXListener

java.lang.String removeInterfaceXListener(java.lang.String observerURI)

updateWorkItemData

java.lang.String updateWorkItemData(java.lang.String workItemID,
                                    java.lang.String data,
                                    java.lang.String sessionHandle)

updateCaseData

java.lang.String updateCaseData(java.lang.String idStr,
                                java.lang.String data,
                                java.lang.String sessionHandle)

restartWorkItem

java.lang.String restartWorkItem(java.lang.String workItemID,
                                 java.lang.String sessionHandle)
                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

cancelWorkItem

java.lang.String cancelWorkItem(java.lang.String id,
                                java.lang.String data,
                                java.lang.String fail,
                                java.lang.String sessionHandle)
                         throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getLatestSpecVersion

java.lang.String getLatestSpecVersion(java.lang.String id,
                                      java.lang.String sessionHandle)
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getMITaskAttributes

java.lang.String getMITaskAttributes(YSpecificationID specificationID,
                                     java.lang.String taskID,
                                     java.lang.String sessionHandle)
                              throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getResourcingSpecs

java.lang.String getResourcingSpecs(YSpecificationID specificationID,
                                    java.lang.String taskID,
                                    java.lang.String sessionHandle)
                             throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getCaseData

java.lang.String getCaseData(java.lang.String caseID,
                             java.lang.String sessionHandle)
                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getCaseInstanceSummary

java.lang.String getCaseInstanceSummary(java.lang.String sessionHandle)
                                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getWorkItemInstanceSummary

java.lang.String getWorkItemInstanceSummary(java.lang.String caseID,
                                            java.lang.String sessionHandle)
                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getParameterInstanceSummary

java.lang.String getParameterInstanceSummary(java.lang.String caseID,
                                             java.lang.String itemID,
                                             java.lang.String sessionHandle)
                                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

rejectAnnouncedEnabledTask

java.lang.String rejectAnnouncedEnabledTask(java.lang.String itemID,
                                            java.lang.String sessionHandle)
                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getExternalDBGateways

java.lang.String getExternalDBGateways(java.lang.String sessionHandle)
                                throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

setHibernateStatisticsEnabled

java.lang.String setHibernateStatisticsEnabled(boolean enabled,
                                               java.lang.String sessionHandle)

isHibernateStatisticsEnabled

java.lang.String isHibernateStatisticsEnabled(java.lang.String sessionHandle)

getHibernateStatistics

java.lang.String getHibernateStatistics(java.lang.String sessionHandle)