org.yawlfoundation.yawl.mailService

Class MailService

java.lang.Object

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

org.yawlfoundation.yawl.mailService.MailService

public class MailService
extends InterfaceBWebsideController

A service that provides for emails to be sent by tasks

Author:

Michael Adams

Created/Last Date:

25/07/2009

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
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.
static MailService	getInstance()
void	handleCancelledWorkItemEvent(WorkItemRecord workItemRecord) Receives notification from the engine that an active workitem has been cancelled.
void	handleEnabledWorkItemEvent(WorkItemRecord wir) Receives notification from the engine of an enabled workitem.
protected void	setFromAddress(java.lang.String address)
protected void	setFromName(java.lang.String name)
protected void	setHost(java.lang.String host)
protected void	setPassword(java.lang.String password)
protected void	setPort(int port)
protected void	setTransportStrategy(java.lang.String strategy)
protected void	setUser(java.lang.String user)

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, 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 MailService getInstance()

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 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

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.

setHost

protected void setHost(java.lang.String host)

setPort

protected void setPort(int port)

setTransportStrategy

protected void setTransportStrategy(java.lang.String strategy)

setUser

protected void setUser(java.lang.String user)

setPassword

protected void setPassword(java.lang.String password)

setFromName

protected void setFromName(java.lang.String name)

setFromAddress

protected void setFromAddress(java.lang.String address)