pro.taskana

Interface TaskService

All Known Implementing Classes:

TaskServiceImpl

public interface TaskService

The Task Service manages all operations on tasks.

Method Summary

Modifier and Type	Method and Description
Task	claim(String taskId) Claim an existing task for the current user.
Task	claim(String taskId, boolean forceClaim) Claim an existing task for the current user.
Task	completeTask(String taskId) Complete a claimed Task as owner/admin and update State and Timestamps.
Task	completeTask(String taskId, boolean isForced) Complete a claimed Task and update State and Timestamps.
Task	createTask(Task taskToCreate) Persists a not persisted Task which does not exist already.
TaskQuery	createTaskQuery() This method provides a query builder for quering the database.
Task	getTaskById(String taskId) Get the details of a task by Id.
List<Task>	getTasksByWorkbasketKeyAndState(String workbasketKey, TaskState taskState) Getting a list of all Tasks which got matching workbasketIds and states.
List<TaskSummary>	getTaskSummariesByWorkbasketKey(String workbasketKey) Getting a short summary of all tasks in a specific work basket.
Task	newTask() Returns a not persisted instance of Task.
Task	setTaskRead(String taskId, boolean isRead) Marks a task as read.
Task	transfer(String taskId, String workbasketKey) Transfer a task to another work basket.

Method Detail

claim

Task claim(String taskId)
    throws TaskNotFoundException,
           InvalidStateException,
           InvalidOwnerException

Claim an existing task for the current user.

Parameters:

taskId - the id of the task to be claimed

Returns:

claimed Task

Throws:

TaskNotFoundException - if the task with taskId was not found

InvalidStateException - if the state of the task with taskId is not TaskState.READY

InvalidOwnerException - if the task with taskId is claimed by some else

claim

Task claim(String taskId,
           boolean forceClaim)
    throws TaskNotFoundException,
           InvalidStateException,
           InvalidOwnerException

Claim an existing task for the current user. Enable forced claim.

Parameters:

taskId - the id of the task to be claimed

forceClaim - if true, claim is performed even if the task is already claimed by someone else

Returns:

claimed Task

Throws:

TaskNotFoundException - if the task with taskId was not found

InvalidStateException - if the state of the task with taskId is not TaskState.READY

InvalidOwnerException - if the task with taskId is claimed by someone else

completeTask

Task completeTask(String taskId)
           throws TaskNotFoundException,
                  InvalidOwnerException,
                  InvalidStateException

Complete a claimed Task as owner/admin and update State and Timestamps.

Parameters:

taskId - - Id of the Task which should be completed.

Returns:

Task - updated task after completion.

Throws:

InvalidStateException - when Task wasn´t claimed before.

TaskNotFoundException - if the given Task can´t be found in DB.

InvalidOwnerException - if current user is not the task-owner or administrator.

completeTask

Task completeTask(String taskId,
                  boolean isForced)
           throws TaskNotFoundException,
                  InvalidOwnerException,
                  InvalidStateException

Complete a claimed Task and update State and Timestamps.

Parameters:

taskId - - Id of the Task which should be completed.

isForced - - Flag which can complete a Task in every case if Task does exist.

Returns:

Task - updated task after completion.

Throws:

InvalidStateException - when Task wasn´t claimed before.

TaskNotFoundException - if the given Task can´t be found in DB.

InvalidOwnerException - if current user is not the task-owner or administrator.

createTask

Task createTask(Task taskToCreate)
         throws NotAuthorizedException,
                WorkbasketNotFoundException,
                ClassificationNotFoundException,
                TaskAlreadyExistException,
                InvalidWorkbasketException

Persists a not persisted Task which does not exist already.

Parameters:

taskToCreate - the transient task object to be persisted

Returns:

the created and persisted task

Throws:

TaskAlreadyExistException - when the Task does already exist.

NotAuthorizedException - thrown if the current user is not authorized to create that task

WorkbasketNotFoundException - thrown if the work basket referenced by the task is not found

ClassificationNotFoundException - thrown if the Classification referenced by the task is not found

InvalidWorkbasketException - thrown if the referenced Workbasket has missing required properties

getTaskById

Task getTaskById(String taskId)
          throws TaskNotFoundException

Get the details of a task by Id.

Parameters:

taskId - the id of the task

Returns:

the Task

Throws:

TaskNotFoundException - thrown of the Task with taskId is not found

transfer

Task transfer(String taskId,
              String workbasketKey)
       throws TaskNotFoundException,
              WorkbasketNotFoundException,
              NotAuthorizedException,
              InvalidWorkbasketException

Transfer a task to another work basket. The transfer sets the transferred flag and resets the read flag.

Parameters:

taskId - The id of the Task to be transferred

workbasketKey - The key of the target work basket

Returns:

the transferred task

Throws:

TaskNotFoundException - Thrown if the Task with taskId was not found.

WorkbasketNotFoundException - Thrown if the target work basket was not found.

NotAuthorizedException - Thrown if the current user is not authorized to transfer this Task to the target work basket

InvalidWorkbasketException - Thrown if either the source or the target workbasket has a missing required property

setTaskRead

Task setTaskRead(String taskId,
                 boolean isRead)
          throws TaskNotFoundException

Marks a task as read.

Parameters:

taskId - the id of the task to be updated

isRead - the new status of the read flag.

Returns:

the updated Task

Throws:

TaskNotFoundException - Thrown if the Task with taskId was not found

createTaskQuery

TaskQuery createTaskQuery()

This method provides a query builder for quering the database.

Returns:

a TaskQuery

getTasksByWorkbasketKeyAndState

List<Task> getTasksByWorkbasketKeyAndState(String workbasketKey,
                                           TaskState taskState)
                                    throws WorkbasketNotFoundException,
                                           NotAuthorizedException

Getting a list of all Tasks which got matching workbasketIds and states.

Parameters:

workbasketKey - the key of the workbasket where the tasks need to be in.

taskState - which is required for the request,

Returns:

a filled/empty list of tasks with attributes which are matching given params.

Throws:

WorkbasketNotFoundException - if the workbasketId can´t be resolved to a existing work basket.

NotAuthorizedException - if the current user got no rights for reading on this work basket.

getTaskSummariesByWorkbasketKey

List<TaskSummary> getTaskSummariesByWorkbasketKey(String workbasketKey)
                                           throws WorkbasketNotFoundException,
                                                  InvalidWorkbasketException

Getting a short summary of all tasks in a specific work basket.

Parameters:

workbasketKey - Key of work basket where tasks are located.

Returns:

TaskSummaryList with all TaskSummaries of a work basket

Throws:

WorkbasketNotFoundException - if a Work basket can´t be located.

InvalidWorkbasketException - thrown if the Workbasket specified with workbasketId has a missing required property

newTask

Task newTask()

Returns a not persisted instance of Task.

Returns:

task - with default values