pro.taskana.adapter.systemconnector.api

Interface SystemConnector

public interface SystemConnector

This is the interface, a System Connector has to implement.

Method Summary

Modifier and Type	Method and Description
SystemResponse	cancelClaimReferencedTask(ReferencedTask task) Instruct the external system to claim a task.
SystemResponse	claimReferencedTask(ReferencedTask task) Instruct the external system to claim a task.
SystemResponse	completeReferencedTask(ReferencedTask task) Instruct the external system to complete a task.
String	getSystemUrl() Get the URL of the external system this connector connects to.
List<ReferencedTask>	retrieveFinishedReferencedTasks() Retrieve ReferencedTasks that were finished.
List<ReferencedTask>	retrieveNewStartedReferencedTasks() Retrieve ReferencedTasks that were started within the last polling interval.
String	retrieveReferencedTaskVariables(String taskId) Get the variables of the ReferencedTask.
void	taskanaTasksHaveBeenCreatedForNewReferencedTasks(List<ReferencedTask> referencedTasks) With this call the Adapter notifies the SystemConnector that a list of TASKANA tasks has been created.
void	taskanaTasksHaveBeenTerminatedForFinishedReferencedTasks(List<ReferencedTask> referencedTasks) With this call the Adapter notifies the SystemConnector that a list of TASKANA tasks has been terminated.

Method Detail

retrieveNewStartedReferencedTasks

List<ReferencedTask> retrieveNewStartedReferencedTasks()

Retrieve ReferencedTasks that were started within the last polling interval.

Returns:

a list of created ReferencedTasks that don't have an associated TASKANA task yet.

taskanaTasksHaveBeenCreatedForNewReferencedTasks

void taskanaTasksHaveBeenCreatedForNewReferencedTasks(List<ReferencedTask> referencedTasks)

With this call the Adapter notifies the SystemConnector that a list of TASKANA tasks has been created. Depending on the Implementation of the SystemConnector, it may ignore this call.

Parameters:

referencedTasks - List of ReferencedTasks for which TASKANA tasks have been created.

retrieveFinishedReferencedTasks

List<ReferencedTask> retrieveFinishedReferencedTasks()

Retrieve ReferencedTasks that were finished.

Returns:

a list of ReferencedTasks that were finished

taskanaTasksHaveBeenTerminatedForFinishedReferencedTasks

void taskanaTasksHaveBeenTerminatedForFinishedReferencedTasks(List<ReferencedTask> referencedTasks)

With this call the Adapter notifies the SystemConnector that a list of TASKANA tasks has been terminated. The rationale for this action is that ReferencedTasks in the external system were finished. Depending on the Implementation of the SystemConnector, it may ignore this call.

Parameters:

referencedTasks - List of ReferencedTasks for which TASKANA Tasks have been terminated.

retrieveReferencedTaskVariables

String retrieveReferencedTaskVariables(String taskId)

Get the variables of the ReferencedTask.

Parameters:

taskId - the Id of the ReferencedTask.

Returns:

the variables of the ReferencedTask.

completeReferencedTask

SystemResponse completeReferencedTask(ReferencedTask task)

Instruct the external system to complete a task.

Parameters:

task - the task to be completed.

Returns:

the response from the external system.

claimReferencedTask

SystemResponse claimReferencedTask(ReferencedTask task)

Instruct the external system to claim a task.

Parameters:

task - the task to be claimed.

Returns:

the response from the external system.

cancelClaimReferencedTask

SystemResponse cancelClaimReferencedTask(ReferencedTask task)

Instruct the external system to claim a task.

Parameters:

task - the task to cancel the claim on.

Returns:

the response from the external system.

getSystemUrl

String getSystemUrl()

Get the URL of the external system this connector connects to.

Returns:

the URL of the connected external system.