org.yawlfoundation.yawl.procletService.util

Class TimeService

java.lang.Object

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

org.yawlfoundation.yawl.procletService.util.TimeService

public class TimeService
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

Constructor Summary

Constructors

Constructor and Description
TimeService()

Method Summary

Modifier and Type	Method and Description
YParameter[]	describeRequiredParams() Override this method if you wish to allow other tools to find out what input parameters are required for your custom YAWL service to work.
void	finish(WorkItemRecord itemRecord, java.lang.String _sessionHandle)
void	handleCancelledWorkItemEvent(WorkItemRecord workItemRecord) Receives notification from the engine that an active workitem has been cancelled.
void	handleEnabledWorkItemEvent(WorkItemRecord workItemRecord) Receives notification from the engine of an enabled workitem.
static void	main(java.lang.String[] args)
java.lang.String	processRequestToCancel(WorkItemRecord workItemRecord)
void	setRemoteAuthenticationDetails(java.lang.String userName, java.lang.String password, java.lang.String httpProxyHost, java.lang.String proxyPort) If a custom service is installed outside of a firewall then you will need to set this method once.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeService

public TimeService()

Method Detail

handleEnabledWorkItemEvent

public void handleEnabledWorkItemEvent(WorkItemRecord workItemRecord)

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:

workItemRecord - the enabled work item

describeRequiredParams

public YParameter[] describeRequiredParams()

Description copied from class: InterfaceBWebsideController

Override this method if you wish to allow other tools to find out what input parameters are required for your custom YAWL service to work.

Overrides:

describeRequiredParams in class InterfaceBWebsideController

Returns:

an array of input parameters.

handleCancelledWorkItemEvent

public void handleCancelledWorkItemEvent(WorkItemRecord workItemRecord)

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:

workItemRecord - the cancelled work item

processRequestToCancel

public java.lang.String processRequestToCancel(WorkItemRecord workItemRecord)

setRemoteAuthenticationDetails

public void setRemoteAuthenticationDetails(java.lang.String userName,
                                           java.lang.String password,
                                           java.lang.String httpProxyHost,
                                           java.lang.String proxyPort)

Description copied from class: InterfaceBWebsideController

If a custom service is installed outside of a firewall then you will need to set this method once. Doing so will allow the WSIF code to access Web services outside your organisation's firewall (http authenticating proxy). NOTE: If your custom YAWL service doesn't need to negotiate a a firewall this method can be ignored

Overrides:

setRemoteAuthenticationDetails in class InterfaceBWebsideController

Parameters:

userName - mandatory

password - mandatory

httpProxyHost - optional (if using a non authenticating proxy firewall).

proxyPort - optional (if using a non authenticating proxy firewall).

finish

public void finish(WorkItemRecord itemRecord,
                   java.lang.String _sessionHandle)

main

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