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 id, String userName) Claim an existing task.
Task	complete(String taskId) Set task to completed.
Task	createTask(Task task) Create a task by a task object.
TaskQuery	createTaskQuery() This method provides a query builder for quering the database.
Task	getTaskById(String taskId) Get the details of a task.
List<DueWorkbasketCounter>	getTaskCountByWorkbasketAndDaysInPastAndState(long daysInPast, List<TaskState> states)
List<TaskStateCounter>	getTaskCountForState(List<TaskState> states) This method counts all tasks with a given state.
long	getTaskCountForWorkbasketByDaysInPastAndState(String workbasketId, long daysInPast, List<TaskState> states) Count all Tasks in a given workbasket with daysInPast as Days from today in the past and a specific state.
List<Task>	getTasksByWorkbasketIdAndState(String workbasketId, TaskState taskState) Getting a list of all Tasks which got matching workbasketIds and states.
List<TaskSummary>	getTaskSummariesByWorkbasketId(String workbasketId) Getting a short summary of all tasks in a specific workbasket.
Task	setTaskRead(String taskId, boolean isRead) Marks a task as read.
Task	transfer(String taskId, String workbasketId) Transfer task to another workbasket.

Method Detail

claim

Task claim(String id,
           String userName)
    throws TaskNotFoundException

Claim an existing task.

Parameters:

id - task id

userName - user who claims the task

Returns:

modified claimed Task

Throws:

TaskNotFoundException - TODO

complete

Task complete(String taskId)
       throws TaskNotFoundException

Set task to completed.

Parameters:

taskId - the task id

Returns:

changed Task after update.

Throws:

TaskNotFoundException - TODO

createTask

Task createTask(Task task)
         throws NotAuthorizedException,
                WorkbasketNotFoundException,
                ClassificationNotFoundException

Create a task by a task object.

Parameters:

task - TODO

Returns:

the created task

Throws:

NotAuthorizedException - TODO

WorkbasketNotFoundException - TODO

ClassificationNotFoundException - TODO

getTaskById

Task getTaskById(String taskId)
          throws TaskNotFoundException

Get the details of a task.

Parameters:

taskId - the id of the task

Returns:

the Task

Throws:

TaskNotFoundException - TODO

getTaskCountForState

List<TaskStateCounter> getTaskCountForState(List<TaskState> states)

This method counts all tasks with a given state.

Parameters:

states - the countable states

Returns:

a List of TaskStateCounter

getTaskCountForWorkbasketByDaysInPastAndState

long getTaskCountForWorkbasketByDaysInPastAndState(String workbasketId,
                                                   long daysInPast,
                                                   List<TaskState> states)

Count all Tasks in a given workbasket with daysInPast as Days from today in the past and a specific state.

Parameters:

workbasketId - TODO

daysInPast - TODO

states - TODO

Returns:

TODO

getTaskCountByWorkbasketAndDaysInPastAndState

List<DueWorkbasketCounter> getTaskCountByWorkbasketAndDaysInPastAndState(long daysInPast,
                                                                         List<TaskState> states)

transfer

Task transfer(String taskId,
              String workbasketId)
       throws TaskNotFoundException,
              WorkbasketNotFoundException,
              NotAuthorizedException

Transfer task to another workbasket. The transfer set the transferred flag and resets the read flag.

Parameters:

taskId - TODO

workbasketId - TODO

Returns:

the updated task

Throws:

TaskNotFoundException - TODO

WorkbasketNotFoundException - TODO

NotAuthorizedException - TODO

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:

Task the updated Task

Throws:

TaskNotFoundException - TODO

createTaskQuery

TaskQuery createTaskQuery()

This method provides a query builder for quering the database.

Returns:

a TaskQuery

getTasksByWorkbasketIdAndState

List<Task> getTasksByWorkbasketIdAndState(String workbasketId,
                                          TaskState taskState)
                                   throws WorkbasketNotFoundException,
                                          NotAuthorizedException,
                                          Exception

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

Parameters:

workbasketId - 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 workbasket.

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

Exception - if no result can be found by @{link TaskMapper}.

getTaskSummariesByWorkbasketId

List<TaskSummary> getTaskSummariesByWorkbasketId(String workbasketId)
                                          throws WorkbasketNotFoundException

Getting a short summary of all tasks in a specific workbasket.

Parameters:

workbasketId - ID of workbasket where tasks are located.

Returns:

TaskSummaryList with all TaskSummaries of a workbasket

Throws:

WorkbasketNotFoundException - if a Workbasket can´t be located.