Package pro.taskana.adapter.taskanaconnector.api

Interface TaskanaConnector

  • public interface TaskanaConnector
    The interface that must be implemented by a SystemConnector to a TASKANA system.

    • Method Detail

      • retrieveFinishedTaskanaTasksAsReferencedTasks

        List<ReferencedTask> retrieveFinishedTaskanaTasksAsReferencedTasks()
        retrieve finished TASKANA tasks.
        Returns:
        a list of finished TASKANA tasks

      • retrieveClaimedTaskanaTasksAsReferencedTasks

        List<ReferencedTask> retrieveClaimedTaskanaTasksAsReferencedTasks()
        retrieve claimed TASKANA tasks.
        Returns:
        a list of claimed TASKANA tasks

      • retrieveCancelledClaimTaskanaTasksAsReferencedTasks

        List<ReferencedTask> retrieveCancelledClaimTaskanaTasksAsReferencedTasks()
        retrieve cancelled claim TASKANA tasks.
        Returns:
        a list of cancelled claim TASKANA tasks

      • changeTaskCallbackState

        void changeTaskCallbackState​(List<ReferencedTask> referencedTasks,
                             pro.taskana.task.api.CallbackState desiredCallbackState)
        With this call the Adapter notifies the TaskanaConnector that the CallbackState of a list of ReferencedTasks needs to be modified due to completion or claim of tasks of TASKANA Tasks. Depending on the Implementation of the System Connector, it may ignore this call.
        Parameters:
        referencedTasks - List of ReferencedTasks that have been completed on the external system
        desiredCallbackState - the CallbackState that needs to be set for the list of referencedTasks

      • createTaskanaTask

        void createTaskanaTask​(pro.taskana.task.api.models.Task taskanaTask)
                throws TaskCreationFailedException
        create a task in TASKANA on behalf of an external task.
        Parameters:
        taskanaTask - The TASKANA task to be created.
        Throws:
        TaskCreationFailedException - if the attempt to create a TASKANA task failed.

      • convertToTaskanaTask

        pro.taskana.task.api.models.Task convertToTaskanaTask​(ReferencedTask referencedTask)
        Convert a ReferencedTask to a TASKANA task.
        Parameters:
        referencedTask - the ReferencedTask that is to be converted.
        Returns:
        the TASKANA task that will be created started on behalf of the ReferencedTask.

      • convertToReferencedTask

        ReferencedTask convertToReferencedTask​(pro.taskana.task.api.models.Task task)
        Convert a TASKANA task into a ReferencedTask.
        Parameters:
        task - the TASKANA task that was executed on behalf of a ReferencedTask.
        Returns:
        the ReferencedTask for which the TASKANA task was executed.

      • terminateTaskanaTask

        void terminateTaskanaTask​(ReferencedTask referencedTask)
                   throws TaskTerminationFailedException
        terminate TASKANA task that runs on behalf of an external task.
        Parameters:
        referencedTask - The external task on behalf of which the TASKANA task is running.
        Throws:
        TaskTerminationFailedException - if the attempt to terminate a TASKANA task failed.