pro.taskana.impl

Class TaskServiceImpl

java.lang.Object

pro.taskana.impl.TaskServiceImpl

All Implemented Interfaces:

TaskService

public class TaskServiceImpl
extends Object
implements TaskService

This is the implementation of TaskService.

Constructor Summary

Constructors

Constructor and Description
TaskServiceImpl(TaskanaEngine taskanaEngine, TaskMapper taskMapper, ObjectReferenceMapper objectReferenceMapper)

Method Summary

Modifier and Type	Method and Description
Task	claim(String id, String userName) Claim an existing task.
Task	complete(String id) 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 id) 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 destinationWorkbasketId) Transfer task to another workbasket.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskServiceImpl

public TaskServiceImpl(TaskanaEngine taskanaEngine,
                       TaskMapper taskMapper,
                       ObjectReferenceMapper objectReferenceMapper)

Method Detail

claim

public Task claim(String id,
                  String userName)
           throws TaskNotFoundException

Description copied from interface: TaskService

Claim an existing task.

Specified by:

claim in interface TaskService

Parameters:

id - task id

userName - user who claims the task

Returns:

modified claimed Task

Throws:

TaskNotFoundException - TODO

complete

public Task complete(String id)
              throws TaskNotFoundException

Description copied from interface: TaskService

Set task to completed.

Specified by:

complete in interface TaskService

Parameters:

id - the task id

Returns:

changed Task after update.

Throws:

TaskNotFoundException - TODO

createTask

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

Description copied from interface: TaskService

Create a task by a task object.

Specified by:

createTask in interface TaskService

Parameters:

task - TODO

Returns:

the created task

Throws:

NotAuthorizedException - TODO

WorkbasketNotFoundException - TODO

ClassificationNotFoundException - TODO

getTaskById

public Task getTaskById(String id)
                 throws TaskNotFoundException

Description copied from interface: TaskService

Get the details of a task.

Specified by:

getTaskById in interface TaskService

Parameters:

id - the id of the task

Returns:

the Task

Throws:

TaskNotFoundException - TODO

getTaskCountForState

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

Description copied from interface: TaskService

This method counts all tasks with a given state.

Specified by:

getTaskCountForState in interface TaskService

Parameters:

states - the countable states

Returns:

a List of TaskStateCounter

getTaskCountForWorkbasketByDaysInPastAndState

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

Description copied from interface: TaskService

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

Specified by:

getTaskCountForWorkbasketByDaysInPastAndState in interface TaskService

Parameters:

workbasketId - TODO

daysInPast - TODO

states - TODO

Returns:

TODO

transfer

public Task transfer(String taskId,
                     String destinationWorkbasketId)
              throws TaskNotFoundException,
                     WorkbasketNotFoundException,
                     NotAuthorizedException

Description copied from interface: TaskService

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

Specified by:

transfer in interface TaskService

Parameters:

taskId - TODO

destinationWorkbasketId - TODO

Returns:

the updated task

Throws:

TaskNotFoundException - TODO

WorkbasketNotFoundException - TODO

NotAuthorizedException - TODO

getTaskCountByWorkbasketAndDaysInPastAndState

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

Specified by:

getTaskCountByWorkbasketAndDaysInPastAndState in interface TaskService

setTaskRead

public Task setTaskRead(String taskId,
                        boolean isRead)
                 throws TaskNotFoundException

Description copied from interface: TaskService

Marks a task as read.

Specified by:

setTaskRead in interface TaskService

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

public TaskQuery createTaskQuery()

Description copied from interface: TaskService

This method provides a query builder for quering the database.

Specified by:

createTaskQuery in interface TaskService

Returns:

a TaskQuery

getTasksByWorkbasketIdAndState

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

Description copied from interface: TaskService

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

Specified by:

getTasksByWorkbasketIdAndState in interface TaskService

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

public List<TaskSummary> getTaskSummariesByWorkbasketId(String workbasketId)
                                                 throws WorkbasketNotFoundException

Description copied from interface: TaskService

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

Specified by:

getTaskSummariesByWorkbasketId in interface TaskService

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.