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.

Method Summary

Modifier and Type	Method and Description
Task	cancelClaim(String taskId) Cancel the claim of an existing task if it was claimed by the current user before.
Task	claim(String taskId) Claim an existing task for the current user.
Task	completeTask(String taskId) Complete a claimed Task as owner/admin and update State and Timestamps.
BulkOperationResults<String,TaskanaException>	completeTasks(List<String> taskIds) Completes a list of tasks.
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.
void	deleteTask(String taskId) Deletes the task with the given Id.
BulkOperationResults<String,TaskanaException>	deleteTasks(List<String> taskIds) Deletes a list of tasks.
Task	forceCancelClaim(String taskId) Cancel the claim of an existing task even if it was claimed by another user.
Task	forceClaim(String taskId) Claim an existing task for the current user even if it is already claimed by someone else.
Task	forceCompleteTask(String taskId) Complete a Task and update State and Timestamps in every case if the Task exists.
void	forceDeleteTask(String taskId) Deletes the task with the given Id even if it is not completed.
Task	getTask(String id) Get the details of a task by Id without checking permissions.
Attachment	newAttachment() Returns a not persisted instance of Attachment.
Task	newTask(String workbasketId) Returns a not persisted instance of Task.
Task	newTask(String workbasketKey, String domain) Returns a not persisted instance of Task.
Task	setTaskRead(String taskId, boolean isRead) Marks a task as read.
Task	transfer(String taskId, String destinationWorkbasketId) Transfer a task to another work basket.
Task	transfer(String taskId, String destinationWorkbasketKey, String domain) Transfer a task to another work basket.
BulkOperationResults<String,TaskanaException>	transferTasks(String destinationWorkbasketId, List<String> taskIds) Transfers a list of tasks to an other workbasket.
BulkOperationResults<String,TaskanaException>	transferTasks(String destinationWorkbasketKey, String destinationWorkbasketDomain, List<String> taskIds) Transfers a list of tasks to an other workbasket.
Task	updateTask(Task task) Update a task.
List<String>	updateTasks(ObjectReference selectionCriteria, Map<String,String> customFieldsToUpdate) Completes tasks with a matching ObjectReference.

Methods inherited from class java.lang.Object

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

Method Detail

claim

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

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 READY

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

NotAuthorizedException - if the current user has no read permission for the workbasket the task is in

forceClaim

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

Description copied from interface: TaskService

Claim an existing task for the current user even if it is already claimed by someone else.

Specified by:

forceClaim 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 READY

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

NotAuthorizedException - if the current user has no read permission for the workbasket the task is in

cancelClaim

public Task cancelClaim(String taskId)
                 throws TaskNotFoundException,
                        InvalidStateException,
                        InvalidOwnerException,
                        NotAuthorizedException

Description copied from interface: TaskService

Cancel the claim of an existing task if it was claimed by the current user before.

Specified by:

cancelClaim in interface TaskService

Parameters:

taskId - id of the task which should be unclaimed.

Returns:

updated unclaimed task

Throws:

TaskNotFoundException - if the task can´t be found or does not exist

InvalidStateException - when the task is already completed.

InvalidOwnerException - when the task is claimed by another user.

NotAuthorizedException - if the current user has no read permission for the workbasket the task is in

forceCancelClaim

public Task forceCancelClaim(String taskId)
                      throws TaskNotFoundException,
                             InvalidStateException,
                             InvalidOwnerException,
                             NotAuthorizedException

Description copied from interface: TaskService

Cancel the claim of an existing task even if it was claimed by another user.

Specified by:

forceCancelClaim in interface TaskService

Parameters:

taskId - id of the task which should be unclaimed.

Returns:

updated unclaimed task

Throws:

TaskNotFoundException - if the task can´t be found or does not exist

InvalidStateException - when the task is already completed.

InvalidOwnerException - when forceCancel is false and the task is claimed by another user.

NotAuthorizedException - if the current user has no read permission for the workbasket the task is in

completeTask

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

Description copied from interface: TaskService

Complete a claimed Task as owner/admin and update State and Timestamps. If task is already completed, the task is returned as itself.

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.

NotAuthorizedException - if the current user has no read permission for the workbasket the task is in

forceCompleteTask

public Task forceCompleteTask(String taskId)
                       throws TaskNotFoundException,
                              InvalidOwnerException,
                              InvalidStateException,
                              NotAuthorizedException

Description copied from interface: TaskService

Complete a Task and update State and Timestamps in every case if the Task exists. If task is already completed, the task is returned as itself.

Specified by:

forceCompleteTask 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.

NotAuthorizedException - if the current user has no read permission for the workbasket the task is in

completeTasks

public BulkOperationResults<String,TaskanaException> completeTasks(List<String> taskIds)
                                                            throws InvalidArgumentException

Description copied from interface: TaskService

Completes a list of tasks.

Specified by:

completeTasks in interface TaskService

Parameters:

taskIds - of the tasks which should be completed.

Returns:

the result of the operations with Id and Exception for each failed task completion.

Throws:

InvalidArgumentException - If the taskId parameter is NULL.

createTask

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

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.

InvalidArgumentException - thrown if the primary ObjectReference is invalid

getTask

public Task getTask(String id)
             throws TaskNotFoundException,
                    NotAuthorizedException

Description copied from interface: TaskService

Get the details of a task by Id without checking permissions.

Specified by:

getTask in interface TaskService

Parameters:

id - the id of the task

Returns:

the Task

Throws:

TaskNotFoundException - thrown of the Task with taskId is not found

NotAuthorizedException - if the current user has no READ permission for the workbasket the task is in.

transfer

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

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

destinationWorkbasketId - The Id 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

InvalidStateException - Thrown if the task is in a state which does not allow transferring

transfer

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

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

domain - The domain 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

InvalidStateException - Thrown if the task is in a state which does not allow transferring

transferTasks

public BulkOperationResults<String,TaskanaException> transferTasks(String destinationWorkbasketId,
                                                                   List<String> taskIds)
                                                            throws NotAuthorizedException,
                                                                   InvalidArgumentException,
                                                                   WorkbasketNotFoundException

Description copied from interface: TaskService

Transfers a list of tasks to an other workbasket. Exceptions will be thrown if the caller got no permissions on the target or it doesn´t exist. Other Exceptions will be stored and returned in the end.

Specified by:

transferTasks in interface TaskService

Parameters:

destinationWorkbasketId - target workbasket id

taskIds - source task which will be moved

Returns:

Bulkresult with ID and Error in it for failed transactions.

Throws:

NotAuthorizedException - if the caller hasn´t permissions on tarket WB.

InvalidArgumentException - if the method paramesters are EMPTY or NULL.

WorkbasketNotFoundException - if the target WB can´t be found.

transferTasks

public BulkOperationResults<String,TaskanaException> transferTasks(String destinationWorkbasketKey,
                                                                   String destinationWorkbasketDomain,
                                                                   List<String> taskIds)
                                                            throws NotAuthorizedException,
                                                                   InvalidArgumentException,
                                                                   WorkbasketNotFoundException

Description copied from interface: TaskService

Transfers a list of tasks to an other workbasket. Exceptions will be thrown if the caller got no permissions on the target or it doesn´t exist. Other Exceptions will be stored and returned in the end.

Specified by:

transferTasks in interface TaskService

Parameters:

destinationWorkbasketKey - target workbasket key

destinationWorkbasketDomain - target workbasket domain

taskIds - source task which will be moved

Returns:

Bulkresult with ID and Error in it for failed transactions.

Throws:

NotAuthorizedException - if the caller hasn´t permissions on tarket WB.

InvalidArgumentException - if the method paramesters are EMPTY or NULL.

WorkbasketNotFoundException - if the target WB can´t be found.

setTaskRead

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

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

NotAuthorizedException - if the current user has no read permission for the workbasket the task is in

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

updateTask

public Task updateTask(Task task)
                throws InvalidArgumentException,
                       TaskNotFoundException,
                       ConcurrencyException,
                       ClassificationNotFoundException,
                       NotAuthorizedException,
                       AttachmentPersistenceException

Description copied from interface: TaskService

Update a task.

Specified by:

updateTask in interface TaskService

Parameters:

task - the task to be updated in the database

Returns:

the updated task

Throws:

InvalidArgumentException - if the task to be updated contains invalid properties like e.g. invalid object references

TaskNotFoundException - if the id of the task is not found in the database

ConcurrencyException - if the task has already been updated by another user

ClassificationNotFoundException - if the updated task refers to a classification that cannot be found

NotAuthorizedException - if the current user is not authorized to update the task

AttachmentPersistenceException - if an Attachment with ID will be added multiple times without using the task-methods.

newTask

public Task newTask(String workbasketId)

Description copied from interface: TaskService

Returns a not persisted instance of Task.

Specified by:

newTask in interface TaskService

Parameters:

workbasketId - the id of the workbasket to which the task belongs

Returns:

an empty new Task

newTask

public Task newTask(String workbasketKey,
                    String domain)

Description copied from interface: TaskService

Returns a not persisted instance of Task.

Specified by:

newTask in interface TaskService

Parameters:

workbasketKey - the key of the workbasket to which the task belongs

domain - the domain of the workbasket to which the task belongs

Returns:

an empty new Task

newAttachment

public Attachment newAttachment()

Description copied from interface: TaskService

Returns a not persisted instance of Attachment.

Specified by:

newAttachment in interface TaskService

Returns:

an empty new Attachment

deleteTask

public void deleteTask(String taskId)
                throws TaskNotFoundException,
                       InvalidStateException,
                       NotAuthorizedException

Description copied from interface: TaskService

Deletes the task with the given Id.

Specified by:

deleteTask in interface TaskService

Parameters:

taskId - The Id of the task to delete.

Throws:

TaskNotFoundException - If the given Id does not refer to an existing task.

InvalidStateException - If the state of the referenced task is not Completed.

NotAuthorizedException - if the current user is not member of role ADMIN

forceDeleteTask

public void forceDeleteTask(String taskId)
                     throws TaskNotFoundException,
                            InvalidStateException,
                            NotAuthorizedException

Description copied from interface: TaskService

Deletes the task with the given Id even if it is not completed.

Specified by:

forceDeleteTask in interface TaskService

Parameters:

taskId - The Id of the task to delete.

Throws:

TaskNotFoundException - If the given Id does not refer to an existing task.

InvalidStateException - If the state of the referenced task is not Completed and forceDelet is false.

NotAuthorizedException - if the current user is not member of role ADMIN

deleteTasks

public BulkOperationResults<String,TaskanaException> deleteTasks(List<String> taskIds)
                                                          throws InvalidArgumentException

Description copied from interface: TaskService

Deletes a list of tasks.

Specified by:

deleteTasks in interface TaskService

Parameters:

taskIds - the ids of the tasks to delete.

Returns:

the result of the operations with Id and Exception for each failed task deletion.

Throws:

InvalidArgumentException - if the TaskIds parameter is NULL

updateTasks

public List<String> updateTasks(ObjectReference selectionCriteria,
                                Map<String,String> customFieldsToUpdate)
                         throws InvalidArgumentException

Description copied from interface: TaskService

Completes tasks with a matching ObjectReference.

Specified by:

updateTasks in interface TaskService

Parameters:

selectionCriteria - the ObjectReference that is used to select the tasks.

customFieldsToUpdate - a Map that contains as key the identification of the custom field and as value the corresponding new value of that custom field. The key for identification of the custom field must be a String with value "1", "2" ... "16" as in the setCustomAttribute or getCustomAttribute method of Task

Returns:

a list of the Ids of all modified tasks

Throws:

InvalidArgumentException - If the customFieldsToUpdate map contains an invalid key or if the selectionCriteria is invalid