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 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 id) 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 destinationWorkbasketKey) Transfer a task to another work basket.

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 taskId)
           throws TaskNotFoundException,
                  InvalidStateException,
                  InvalidOwnerException

Description copied from interface: TaskService

Claim an existing task for the current user.

Specified by:

claim in interface TaskService

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

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

Description copied from interface: TaskService

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

Specified by:

claim in interface TaskService

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

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

Description copied from interface: TaskService

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

Specified by:

completeTask in interface TaskService

Parameters:

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

Returns:

Task - updated task after completion.

Throws:

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

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

InvalidStateException - when Task wasn´t claimed before.

completeTask

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

Description copied from interface: TaskService

Complete a claimed Task and update State and Timestamps.

Specified by:

completeTask in interface TaskService

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:

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

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

InvalidStateException - when Task wasn´t claimed before.

createTask

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

Description copied from interface: TaskService

Persists a not persisted Task which does not exist already.

Specified by:

createTask in interface TaskService

Parameters:

taskToCreate - the transient task object to be persisted

Returns:

the created and persisted task

Throws:

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

TaskAlreadyExistException - when the Task does already exist.

InvalidWorkbasketException - thrown if the referenced Workbasket has missing required properties

getTaskById

public Task getTaskById(String id)
                 throws TaskNotFoundException

Description copied from interface: TaskService

Get the details of a task by Id.

Specified by:

getTaskById in interface TaskService

Parameters:

id - the id of the task

Returns:

the Task

Throws:

TaskNotFoundException - thrown of the Task with taskId is not found

transfer

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

Description copied from interface: TaskService

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

Specified by:

transfer in interface TaskService

Parameters:

taskId - The id of the Task to be transferred

destinationWorkbasketKey - 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

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:

the updated Task

Throws:

TaskNotFoundException - Thrown if the Task with taskId was not found

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

getTasksByWorkbasketKeyAndState

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

Description copied from interface: TaskService

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

Specified by:

getTasksByWorkbasketKeyAndState in interface TaskService

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

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

Description copied from interface: TaskService

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

Specified by:

getTaskSummariesByWorkbasketKey in interface TaskService

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

public Task newTask()

Description copied from interface: TaskService

Returns a not persisted instance of Task.

Specified by:

newTask in interface TaskService

Returns:

task - with default values