com.sap.netweaver.bc.uwl.tes

Interface IPtnTEService

public interface IPtnTEService

Interface of the Task Execution Service known to the Pattern Framework. This interface must be implemented by a Service in order to be consumed by the Pattern Task Execution Action.

Method Summary

IRefBOInfo	showRefBo(String connectionName, String taskId, Locale locale) The passed connection should be used to search for the task with the passed taskId.
ITaskStartResult	startTask(String connectionName, String taskId, Locale locale) The passed connection should be used to search for the task with the passed taskId.

Method Detail

startTask

ITaskStartResult startTask(String connectionName,
                           String taskId,
                           Locale locale)

The passed connection should be used to search for the task with the passed taskId. If a task is found, it should be picked and started for the current user.
If the task should not be reserved for the user, the method #showRefBo(String, String) should be used.

Parameters:

connectionName - the name of the connection (e.g. RFC-connection) that should be used to connect to the backend

taskId - the Id of the task instance that should be picked and started for the user.

locale - the locale that should be used by the service implementation to return localized messages.
If it is null, the service impl will return the default language (probably English).

Returns:

ITaskStartResult containing information on the obn that should be called (if navigation should occur) as well as messages that should be displayed in the UI.

showRefBo

IRefBOInfo showRefBo(String connectionName,
                     String taskId,
                     Locale locale)

The passed connection should be used to search for the task with the passed taskId. If a task is found, only navigation information should be returned.
In order to pick and start a task, #startTask(String, String) must be called.

Parameters:

connectionName - the name of the connection (e.g. RFC-connection) that should be used to connect to the backend

taskId - the Id of the task instance the caller is interested in

locale - the locale that should be used by the service implementation to return localized messages.
If it is null, the service impl will return the default language (probably English).

Returns:

ITaskStartResult containing information on the obn that should be called (if navigation should occur).