TaskServiceImpl (pro.taskana:taskana-core 2.0.1 API)

java.lang.Object
- pro.taskana.task.internal.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(InternalTaskanaEngine taskanaEngine, TaskMapper taskMapper, AttachmentMapper attachmentMapper)

Constructors
Constructor and Description
`TaskServiceImpl(InternalTaskanaEngine taskanaEngine, TaskMapper taskMapper, AttachmentMapper attachmentMapper)`

Method Summary

All Methods Instance Methods Concrete Methods
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> taskIdsToBeCompleted)` 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.
`Set<String>`	`findTasksIdsAffectedByClassificationChange(String classificationId)`
`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()` Returns a not persisted instance of `Task`.
`Task`	`newTask(String workbasketId)` Returns a not persisted instance of `Task`.
`Task`	`newTask(String workbasketKey, String domain)` Returns a not persisted instance of `Task`.
`void`	`refreshPriorityAndDueDate(String taskId)`
`BulkOperationResults<String,TaskanaException>`	`setCallbackStateForTasks(List<String> externalIds, CallbackState state)` Sets the callback state on a list of tasks.
`BulkOperationResults<String,TaskanaException>`	`setOwnerOfTasks(String owner, List<String> argTaskIds)` Sets the owner on a list of tasks.
`BulkOperationResults<String,TaskanaException>`	`setPlannedPropertyOfTasks(Instant planned, List<String> argTaskIds)` Sets the planned property on a list of tasks.
`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 workbasketKey, 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(List<String> taskIds, Map<String,String> customFieldsToUpdate)` Updates tasks with matching taskIds.
`List<String>`	`updateTasks(ObjectReference selectionCriteria, Map<String,String> customFieldsToUpdate)` Updates tasks with a matching `ObjectReference`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TaskServiceImpl
```
public TaskServiceImpl(InternalTaskanaEngine taskanaEngine,
                       TaskMapper taskMapper,
                       AttachmentMapper attachmentMapper)
```
- 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
  - 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 workbasketKey,
                     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
    
    workbasketKey - 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
  - 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
  - newTask
```
public Task newTask()
```
    Description copied from interface: TaskService
    
    Returns a not persisted instance of Task. The returned task has no workbasket Id set. When createTask() is invoked for this task, TaskService will call the TaskRouting SPI to determine a workbasket for the task. If the TaskRouting API is not active, e.g. because no TaskRouter is registered, or the TaskRouter(s) don't find a workbasket, the task will not be persisted.
    
    Specified by:
    
    newTask in interface TaskService
    
    Returns:
    
    an empty new Task
  - 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
  - updateTask
```
public Task updateTask(Task task)
                throws InvalidArgumentException,
                       TaskNotFoundException,
                       ConcurrencyException,
                       ClassificationNotFoundException,
                       NotAuthorizedException,
                       AttachmentPersistenceException,
                       InvalidStateException
```
    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
    
    InvalidStateException - if an attempt is made to change the owner of the task and the task is not in state READY .
  - 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.
  - 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
  - completeTasks
```
public BulkOperationResults<String,TaskanaException> completeTasks(List<String> taskIdsToBeCompleted)
                                                            throws InvalidArgumentException
```
    Description copied from interface: TaskService
    
    Completes a list of tasks.
    
    Specified by:
    
    completeTasks in interface TaskService
    
    Parameters:
    
    taskIdsToBeCompleted - 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.
  - updateTasks
```
public List<String> updateTasks(ObjectReference selectionCriteria,
                                Map<String,String> customFieldsToUpdate)
                         throws InvalidArgumentException
```
    Description copied from interface: TaskService
    
    Updates 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
  - updateTasks
```
public List<String> updateTasks(List<String> taskIds,
                                Map<String,String> customFieldsToUpdate)
                         throws InvalidArgumentException
```
    Description copied from interface: TaskService
    
    Updates tasks with matching taskIds.
    
    Specified by:
    
    updateTasks in interface TaskService
    
    Parameters:
    
    taskIds - the taskIds that are 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
  - setCallbackStateForTasks
```
public BulkOperationResults<String,TaskanaException> setCallbackStateForTasks(List<String> externalIds,
                                                                              CallbackState state)
```
    Description copied from interface: TaskService
    
    Sets the callback state on a list of tasks. Note: this method is primarily intended to be used by the TaskanaAdapter
    
    Specified by:
    
    setCallbackStateForTasks in interface TaskService
    
    Parameters:
    
    externalIds - the EXTERNAL_IDs of the tasks on which the callback state is set.
    
    state - the callback state that is to be set on the tasks
    
    Returns:
    
    the result of the operations with Id and Exception for each failed task deletion.
  - setOwnerOfTasks
```
public BulkOperationResults<String,TaskanaException> setOwnerOfTasks(String owner,
                                                                     List<String> argTaskIds)
```
    Description copied from interface: TaskService
    
    Sets the owner on a list of tasks. The owner will only be set on tasks that are in state READY.
    
    Specified by:
    
    setOwnerOfTasks in interface TaskService
    
    Parameters:
    
    owner - the new owner of the tasks
    
    argTaskIds - the IDs of the tasks on which the owner is to be set.
    
    Returns:
    
    the result of the operations with Id and Exception for each failed task update.
  - setPlannedPropertyOfTasks
```
public BulkOperationResults<String,TaskanaException> setPlannedPropertyOfTasks(Instant planned,
                                                                               List<String> argTaskIds)
```
    Description copied from interface: TaskService
    
    Sets the planned property on a list of tasks. Only tasks in state READY and CLAIMED will be affected by this method. On each task, the corresponding due date is set according to the due dates in the classification() of the task and the task's attachments.
    
    Specified by:
    
    setPlannedPropertyOfTasks in interface TaskService
    
    Parameters:
    
    planned - the new 'PLANNED" property of the tasks
    
    argTaskIds - the IDs of the tasks on which the new planned property is to be set.
    
    Returns:
    
    the result of the operations with Id and Exception for each failed task update.
  - findTasksIdsAffectedByClassificationChange
```
public Set<String> findTasksIdsAffectedByClassificationChange(String classificationId)
```
  - refreshPriorityAndDueDate
```
public void refreshPriorityAndDueDate(String taskId)
                               throws ClassificationNotFoundException
```
    Throws:
    
    ClassificationNotFoundException

Class TaskServiceImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TaskServiceImpl

Method Detail

claim

forceClaim

cancelClaim

forceCancelClaim

completeTask

forceCompleteTask

createTask

getTask

transfer

transfer

setTaskRead

createTaskQuery

newTask

newTask

newTask

newAttachment

updateTask

transferTasks

transferTasks

deleteTask

forceDeleteTask

deleteTasks

completeTasks

updateTasks

updateTasks

setCallbackStateForTasks

setOwnerOfTasks

setPlannedPropertyOfTasks

findTasksIdsAffectedByClassificationChange

refreshPriorityAndDueDate