Package pro.taskana.task.internal

Class TaskServiceImpl

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	Description
TaskServiceImpl(InternalTaskanaEngine taskanaEngine, TaskMapper taskMapper, TaskCommentMapper taskCommentMapper, AttachmentMapper attachmentMapper, ObjectReferenceMapper objectReferenceMapper, UserMapper userMapper)

Method Summary

Modifier and Type	Method	Description
Task	cancelClaim(String taskId)	Cancel the claim of an existing Task if it was claimed by the current user before.
Task	cancelClaim(String taskId, boolean keepOwner)	Cancel the claim of an existing Task if it was claimed by the current user before.
Task	cancelTask(String taskId)	Cancels the Task with the given id.
Task	claim(String taskId)	Claim an existing Task for the current user.
Task	completeTask(String taskId)	Complete a claimed Task as owner or TaskanaRole.ADMIN and update state and timestamps.
BulkOperationResults<String,TaskanaException>	completeTasks(List<String> taskIds)	Completes a List of Tasks.
Task	createTask(Task taskToCreate)	Inserts a Task that doesn't exist in the database yet.
TaskComment	createTaskComment(TaskComment taskComment)	Inserts the specified TaskComment into the database.
TaskCommentQuery	createTaskCommentQuery()	Creates an empty TaskCommentQuery.
TaskQuery	createTaskQuery()	Creates an empty TaskQuery.
void	deleteTask(String taskId)	Deletes the Task with the given id.
void	deleteTaskComment(String taskCommentId)	Deletes the TaskComment with the given id.
BulkOperationResults<String,TaskanaException>	deleteTasks(List<String> taskIds)	Deletes a List of Tasks.
List<String>	findTasksIdsAffectedByClassificationChange(String classificationId)
Task	forceCancelClaim(String taskId)	Cancel the claim of an existing Task even if it was claimed by another user.
Task	forceCancelClaim(String taskId, boolean keepOwner)	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)	Completes a Task and updates state and timestamps in every case if the Task exists.
BulkOperationResults<String,TaskanaException>	forceCompleteTasks(List<String> taskIds)	Completes each existing Task in the given List in every case, independent of the owner or state of the Task.
void	forceDeleteTask(String taskId)	Deletes the Task with the given id even if it isn't completed.
Task	forceRequestChanges(String taskId)	Request changes for an existing Task even if the current user is not the owner or the Task is not in TaskState.IN_REVIEW yet.
Task	forceRequestReview(String taskId)	Request review for an existing Task even if the current user is not the owner or the Task is not in TaskState.CLAIMED yet.
Task	getTask(String id)	Fetches a Task from the database by the specified id.
TaskComment	getTaskComment(String taskCommentid)	Retrieves the TaskComment with the given id.
List<TaskComment>	getTaskComments(String taskId)	Retrieves the List of TaskComments for the Task with given id.
Attachment	newAttachment()	Instantiates a non-persistent/non-inserted Attachment.
ObjectReference	newObjectReference()	Instantiates a non-persistent/non-inserted ObjectReference.
ObjectReference	newObjectReference(String company, String system, String systemInstance, String type, String value)	Instantiates a non-persistent/non-inserted ObjectReference.
Task	newTask()	Instantiates a non-persistent/non-inserted Task.
Task	newTask(String workbasketId)	Instantiates a non-persistent/non-inserted Task.
Task	newTask(String workbasketKey, String domain)	Instantiates a non-persistent/non-inserted Task.
TaskComment	newTaskComment(String taskId)	Instantiates a non-persistent/non-inserted TaskComment.
void	refreshPriorityAndDueDatesOfTasksOnClassificationUpdate(List<String> taskIds, boolean serviceLevelChanged, boolean priorityChanged)
Task	requestChanges(String taskId)	Request changes for an existing Task that is in TaskState.IN_REVIEW.
Task	requestReview(String taskId)	Request review for an existing Task that is in TaskState.CLAIMED.
Optional<Task>	selectAndClaim(TaskQuery taskQuery)	Selects and claims the first Task which is returned by the TaskQuery.
BulkOperationResults<String,TaskanaException>	setCallbackStateForTasks(List<String> externalIds, CallbackState state)	Sets the specified CallbackState on a List of Tasks.
BulkOperationResults<String,TaskanaException>	setOwnerOfTasks(String owner, List<String> taskIds)	Sets the owner on a List of Tasks.
BulkOperationResults<String,TaskanaException>	setPlannedPropertyOfTasks(Instant planned, List<String> argTaskIds)	Sets the planned Instant on a List of Tasks.
Task	setTaskRead(String taskId, boolean isRead)	Sets the value of isRead of the specified Task.
Task	terminateTask(String taskId)	Terminates a Task.
Task	transfer(String taskId, String destinationWorkbasketId, boolean setTransferFlag)	Transfers a Task to another Workbasket.
Task	transfer(String taskId, String workbasketKey, String domain, boolean setTransferFlag)	Transfers a Task to another Workbasket.
BulkOperationResults<String,TaskanaException>	transferTasks(String destinationWorkbasketKey, String destinationWorkbasketDomain, List<String> taskIds, boolean setTransferFlag)	Transfers a List of Tasks to another Workbasket.
BulkOperationResults<String,TaskanaException>	transferTasks(String destinationWorkbasketId, List<String> taskIds, boolean setTransferFlag)	Transfers a List of Tasks to another Workbasket.
BulkOperationResults<String,TaskanaException>	transferTasksWithOwner(String destinationWorkbasketKey, String destinationWorkbasketDomain, List<String> taskIds, String owner, boolean setTransferFlag)	Transfers a List of Tasks to another Workbasket and sets the owner of the Tasks.
BulkOperationResults<String,TaskanaException>	transferTasksWithOwner(String destinationWorkbasketId, List<String> taskIds, String owner, boolean setTransferFlag)	Transfers a List of Tasks to another Workbasket and sets the owner of the Tasks.
Task	transferWithOwner(String taskId, String destinationWorkbasketId, String owner, boolean setTransferFlag)	Transfers a Task to another Workbasket and sets the owner of the Task.
Task	transferWithOwner(String taskId, String workbasketKey, String domain, String owner, boolean setTransferFlag)	Transfers a Task to another Workbasket and sets the owner of the Task.
Task	updateTask(Task task)	Update a Task.
TaskComment	updateTaskComment(TaskComment taskComment)	Updates the specified TaskComment.
List<String>	updateTasks(List<String> taskIds, Map<TaskCustomField,String> customFieldsToUpdate)	Updates specified TaskCustomFields for all given Tasks.
List<String>	updateTasks(ObjectReference selectionCriteria, Map<TaskCustomField,String> customFieldsToUpdate)	Updates specified TaskCustomFields of Tasks associated with the given primaryObjRef.

Methods inherited from class java.lang.Object

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

Methods inherited from interface pro.taskana.task.api.TaskService

transfer, transfer, transferTasks, transferTasks, transferTasksWithOwner, transferTasksWithOwner, transferWithOwner, transferWithOwner

Constructor Details

TaskServiceImpl

public TaskServiceImpl(InternalTaskanaEngine taskanaEngine,
 TaskMapper taskMapper,
 TaskCommentMapper taskCommentMapper,
 AttachmentMapper attachmentMapper,
 ObjectReferenceMapper objectReferenceMapper,
 UserMapper userMapper)

Method Details

claim

public Task claim(String taskId)
           throws TaskNotFoundException,
InvalidOwnerException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException

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:

the claimed Task

Throws:

TaskNotFoundException - if the Task with taskId was not found

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

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

InvalidTaskStateException - if the state of the Task with taskId isn't TaskState.READY

forceClaim

public Task forceClaim(String taskId)
                throws TaskNotFoundException,
InvalidOwnerException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException

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:

the claimed Task

Throws:

TaskNotFoundException - if the Task with taskId was not found

InvalidOwnerException - cannot be thrown

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

InvalidTaskStateException - if the state of Task with taskId is in TaskState.END_STATES

cancelClaim

public Task cancelClaim(String taskId)
                 throws TaskNotFoundException,
InvalidOwnerException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException

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 - the id of the Task which should be unclaimed

Returns:

the unclaimed Task

Throws:

TaskNotFoundException - if the Task with taskId was not found

InvalidOwnerException - if the Task is claimed by another user

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

InvalidTaskStateException - if the Task is already in one of the TaskState.END_STATES

forceCancelClaim

public Task forceCancelClaim(String taskId)
                      throws TaskNotFoundException,
InvalidTaskStateException,
NotAuthorizedOnWorkbasketException

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 - the id of the Task which should be unclaimed

Returns:

the unclaimed Task

Throws:

TaskNotFoundException - if the Task with taskId was not found

InvalidTaskStateException - if the Task is already in one of the TaskState.END_STATES

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

cancelClaim

public Task cancelClaim(String taskId,
 boolean keepOwner)
                 throws TaskNotFoundException,
InvalidOwnerException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException

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 - the id of the Task which should be unclaimed

keepOwner - If set to true, will keep the TaskSummary.getOwner() and TaskSummary.getOwnerLongName()

Returns:

the unclaimed Task

Throws:

TaskNotFoundException - if the Task with taskId was not found

InvalidOwnerException - if the Task is claimed by another user

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

InvalidTaskStateException - if the Task is already in one of the TaskState.END_STATES

forceCancelClaim

public Task forceCancelClaim(String taskId,
 boolean keepOwner)
                      throws TaskNotFoundException,
InvalidTaskStateException,
NotAuthorizedOnWorkbasketException

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 - the id of the Task which should be unclaimed

keepOwner - If set to true, will keep the TaskSummary.getOwner() and TaskSummary.getOwnerLongName()

Returns:

the unclaimed Task

Throws:

TaskNotFoundException - if the Task with taskId was not found

InvalidTaskStateException - if the Task is already in one of the TaskState.END_STATES

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

requestReview

public Task requestReview(String taskId)
                   throws InvalidTaskStateException,
TaskNotFoundException,
InvalidOwnerException,
NotAuthorizedOnWorkbasketException

Description copied from interface: TaskService

Request review for an existing Task that is in TaskState.CLAIMED.

Specified by:

requestReview in interface TaskService

Parameters:

taskId - the id of the specified Task

Returns:

the Task after a review has been requested

Throws:

InvalidTaskStateException - if the state of the Task with taskId is not in TaskState.CLAIMED

TaskNotFoundException - if the Task with taskId wasn't found

InvalidOwnerException - if the Task is claimed by another user

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

forceRequestReview

public Task forceRequestReview(String taskId)
                        throws InvalidTaskStateException,
TaskNotFoundException,
InvalidOwnerException,
NotAuthorizedOnWorkbasketException

Description copied from interface: TaskService

Request review for an existing Task even if the current user is not the owner or the Task is not in TaskState.CLAIMED yet.

Specified by:

forceRequestReview in interface TaskService

Parameters:

taskId - the id of the specified Task

Returns:

the Task after a review has been requested

Throws:

InvalidTaskStateException - if the state of the Task with taskId is one of the TaskState.END_STATES

TaskNotFoundException - if the Task with taskId wasn't found

InvalidOwnerException - cannot be thrown

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

requestChanges

public Task requestChanges(String taskId)
                    throws InvalidTaskStateException,
TaskNotFoundException,
InvalidOwnerException,
NotAuthorizedOnWorkbasketException

Description copied from interface: TaskService

Request changes for an existing Task that is in TaskState.IN_REVIEW. The TaskState is changed to TaskState.READY after changes have been requested.

Specified by:

requestChanges in interface TaskService

Parameters:

taskId - the id of the specified Task

Returns:

the Task after changes have been requested

Throws:

InvalidTaskStateException - if the state of the Task with taskId is not in TaskState.IN_REVIEW

TaskNotFoundException - if the Task with taskId wasn't found

InvalidOwnerException - if the Task is claimed by another user

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

forceRequestChanges

public Task forceRequestChanges(String taskId)
                         throws InvalidTaskStateException,
TaskNotFoundException,
InvalidOwnerException,
NotAuthorizedOnWorkbasketException

Description copied from interface: TaskService

Request changes for an existing Task even if the current user is not the owner or the Task is not in TaskState.IN_REVIEW yet. The TaskState is changed to TaskState.READY after changes have been requested.

Specified by:

forceRequestChanges in interface TaskService

Parameters:

taskId - the id of the specified Task

Returns:

the Task after changes have been requested

Throws:

InvalidTaskStateException - if the state of the Task with taskId is one of the TaskState.END_STATES

TaskNotFoundException - if the Task with taskId wasn't found

InvalidOwnerException - cannot be thrown

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

completeTask

public Task completeTask(String taskId)
                  throws TaskNotFoundException,
InvalidOwnerException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException

Description copied from interface: TaskService

Complete a claimed Task as owner or TaskanaRole.ADMIN and update state and timestamps.

If the Task is already completed, the Task is returned unchanged.

Specified by:

completeTask in interface TaskService

Parameters:

taskId - the id of the Task which should be completed

Returns:

the completed Task

Throws:

TaskNotFoundException - if the Task with taskId wasn't found

InvalidOwnerException - if current user isn't the owner of the Task or TaskanaRole.ADMIN

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

InvalidTaskStateException - if the state of the Task with taskId is neither TaskState.CLAIMED nor TaskState.COMPLETED

forceCompleteTask

public Task forceCompleteTask(String taskId)
                       throws TaskNotFoundException,
InvalidOwnerException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException

Description copied from interface: TaskService

Completes a Task and updates state and timestamps in every case if the Task exists.

If the Task is already completed, the Task is returned unchanged.

Specified by:

forceCompleteTask in interface TaskService

Parameters:

taskId - the id of the Task which should be completed

Returns:

the updated Task after completion

Throws:

TaskNotFoundException - if the Task with taskId wasn't found

InvalidOwnerException - if current user isn't the owner of the Task or TaskanaRole.ADMIN

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

InvalidTaskStateException - if the state of the Task with taskId is with taskId is TaskState.TERMINATED or TaskState.CANCELLED

createTask

public Task createTask(Task taskToCreate)
                throws WorkbasketNotFoundException,
ClassificationNotFoundException,
TaskAlreadyExistException,
InvalidArgumentException,
AttachmentPersistenceException,
ObjectReferencePersistenceException,
NotAuthorizedOnWorkbasketException

Description copied from interface: TaskService

Inserts a Task that doesn't exist in the database yet.

If the workbasketSummary of the given Task is NULL, TaskService will call the TaskRoutingProvider to determine a Workbasket for the Task. If the TaskRoutingProvider is not active, e.g. because no TaskRoutingProvider is registered, or the TaskRoutingProvider doesn't find a Workbasket, the Task will not be inserted.

The default values of the created Task are:

• id - generated automatically
• externalId - if NULL, then generated automatically, else unchanged
• businessProcessId - generated automatically
• name - if NULL then the name of its Classification, else unchanged
• description - if NULL then description of its Classification, else unchanged
• creator - id of current user
• state - TaskState.READY
• isRead - false
• isTransferred - false

Specified by:

createTask in interface TaskService

Parameters:

taskToCreate - the transient Task to be inserted

Returns:

the created and inserted Task

Throws:

WorkbasketNotFoundException - if the Workbasket referenced by the workbasketSummary of the Task isn't found

ClassificationNotFoundException - if the Classification referenced by classificationSummary of the Task isn't found

TaskAlreadyExistException - if the Task already exists

InvalidArgumentException - if the primaryObjRef is invalid

AttachmentPersistenceException - if an Attachment with the same id was added to the Task multiple times without using Task.addAttachment(Attachment)

ObjectReferencePersistenceException - if an ObjectReference with the same id was added to the Task multiple times without using TaskSummary.addSecondaryObjectReference(ObjectReference)

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.APPEND for the Workbasket the Task is in

getTask

public Task getTask(String id)
             throws NotAuthorizedOnWorkbasketException,
TaskNotFoundException

Description copied from interface: TaskService

Fetches a Task from the database by the specified id.

Specified by:

getTask in interface TaskService

Parameters:

id - the id of the Task

Returns:

the Task with the specified taskId

Throws:

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

TaskNotFoundException - if the Task with taskId wasn't found

transfer

public Task transfer(String taskId,
 String destinationWorkbasketId,
 boolean setTransferFlag)
              throws TaskNotFoundException,
WorkbasketNotFoundException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException

Description copied from interface: TaskService

Transfers a Task to another Workbasket.

The transfer resets isRead and sets isTransferred if setTransferFlag is true.

Specified by:

transfer in interface TaskService

Parameters:

taskId - the id of the Task which should be transferred

destinationWorkbasketId - the id of the target Workbasket

setTransferFlag - controls whether to set isTransferred to true or not

Returns:

the transferred Task

Throws:

TaskNotFoundException - if the Task with taskId wasn't found

WorkbasketNotFoundException - if the target Workbasket was not found

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the source Workbasket or no WorkbasketPermission.TRANSFER for the target Workbasket

InvalidTaskStateException - if the Task is in one of the TaskState.END_STATES

transfer

public Task transfer(String taskId,
 String workbasketKey,
 String domain,
 boolean setTransferFlag)
              throws TaskNotFoundException,
WorkbasketNotFoundException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException

Description copied from interface: TaskService

Transfers a Task to another Workbasket.

The transfer resets isRead and sets isTransferred if setTransferFlag is true.

Specified by:

transfer in interface TaskService

Parameters:

taskId - the id of the Task which should be transferred

workbasketKey - the key of the target Workbasket

domain - the domain of the target Workbasket

setTransferFlag - controls whether to set isTransferred or not

Returns:

the transferred Task

Throws:

TaskNotFoundException - if the Task with taskId was not found

WorkbasketNotFoundException - if the target Workbasket was not found

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the source Workbasket or no WorkbasketPermission.TRANSFER for the target Workbasket

InvalidTaskStateException - if the Task is in one of the TaskState.END_STATES

transferWithOwner

public Task transferWithOwner(String taskId,
 String destinationWorkbasketId,
 String owner,
 boolean setTransferFlag)
                       throws TaskNotFoundException,
WorkbasketNotFoundException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException

Description copied from interface: TaskService

Transfers a Task to another Workbasket and sets the owner of the Task.

The transfer resets isRead and sets isTransferred if setTransferFlag is true.

Specified by:

transferWithOwner in interface TaskService

Parameters:

taskId - the id of the Task which should be transferred

destinationWorkbasketId - the id of the target Workbasket

owner - the owner of the Task after it has been transferred

setTransferFlag - controls whether to set isTransferred to true or not

Returns:

the transferred Task

Throws:

TaskNotFoundException - if the Task with taskId wasn't found

WorkbasketNotFoundException - if the target Workbasket was not found

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the source Workbasket or no WorkbasketPermission.TRANSFER for the target Workbasket

InvalidTaskStateException - if the Task is in one of the TaskState.END_STATES

transferWithOwner

public Task transferWithOwner(String taskId,
 String workbasketKey,
 String domain,
 String owner,
 boolean setTransferFlag)
                       throws TaskNotFoundException,
WorkbasketNotFoundException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException

Description copied from interface: TaskService

Transfers a Task to another Workbasket and sets the owner of the Task.

The transfer resets isRead and sets isTransferred if setTransferFlag is true.

Specified by:

transferWithOwner in interface TaskService

Parameters:

taskId - the id of the Task which should be transferred

workbasketKey - the key of the target Workbasket

domain - the domain of the target Workbasket

owner - the owner of the Task after it has been transferred

setTransferFlag - controls whether to set isTransferred or not

Returns:

the transferred Task

Throws:

TaskNotFoundException - if the Task with taskId was not found

WorkbasketNotFoundException - if the target Workbasket was not found

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the source Workbasket or no WorkbasketPermission.TRANSFER for the target Workbasket

InvalidTaskStateException - if the Task is in one of the TaskState.END_STATES

setTaskRead

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

Description copied from interface: TaskService

Sets the value of isRead of the specified Task.

Specified by:

setTaskRead in interface TaskService

Parameters:

taskId - the id of the Task to be updated

isRead - the new status of isRead

Returns:

the updated Task

Throws:

TaskNotFoundException - if the Task with taskId wasn't found

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

createTaskQuery

public TaskQuery createTaskQuery()

Description copied from interface: TaskService

Creates an empty TaskQuery.

Specified by:

createTaskQuery in interface TaskService

Returns:

a TaskQuery

createTaskCommentQuery

public TaskCommentQuery createTaskCommentQuery()

Description copied from interface: TaskService

Creates an empty TaskCommentQuery.

Specified by:

createTaskCommentQuery in interface TaskService

Returns:

a TaskCommentQuery

newTask

public Task newTask()

Description copied from interface: TaskService

Instantiates a non-persistent/non-inserted Task.

Since a Task doesn't allow setting a workbasketSummary, please either provide an implementation of the TaskRoutingProvider or use the referenced methods to create a Task within a specific Workbasket.

Specified by:

newTask in interface TaskService

Returns:

the instantiated Task

See Also:

• TaskService.newTask(String)
• TaskService.newTask(String, String)

newTask

public Task newTask(String workbasketId)

Description copied from interface: TaskService

Instantiates a non-persistent/non-inserted Task.

Specified by:

newTask in interface TaskService

Parameters:

workbasketId - the id of the Workbasket to which the Task belongs

Returns:

the instantiated Task

See Also:

• TaskService.newTask()
• TaskService.newTask(String, String)

newTask

public Task newTask(String workbasketKey,
 String domain)

Description copied from interface: TaskService

Instantiates a non-persistent/non-inserted 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:

the instantiated Task

See Also:

• TaskService.newTask()
• TaskService.newTask(String)

newTaskComment

public TaskComment newTaskComment(String taskId)

Description copied from interface: TaskService

Instantiates a non-persistent/non-inserted TaskComment.

Specified by:

newTaskComment in interface TaskService

Parameters:

taskId - the id of the Task to which the TaskComment belongs

Returns:

the instantiated TaskComment

newAttachment

public Attachment newAttachment()

Description copied from interface: TaskService

Instantiates a non-persistent/non-inserted Attachment.

Specified by:

newAttachment in interface TaskService

Returns:

the instantiated Attachment

newObjectReference

public ObjectReference newObjectReference()

Description copied from interface: TaskService

Instantiates a non-persistent/non-inserted ObjectReference.

Specified by:

newObjectReference in interface TaskService

Returns:

the instantiated ObjectReference

See Also:

• TaskService.newObjectReference(String, String, String, String, String)

newObjectReference

public ObjectReference newObjectReference(String company,
 String system,
 String systemInstance,
 String type,
 String value)

Description copied from interface: TaskService

Instantiates a non-persistent/non-inserted ObjectReference.

Specified by:

newObjectReference in interface TaskService

Parameters:

company - the company of the new ObjectReference

system - the system of the new ObjectReference

systemInstance - the systemInstance of the new ObjectReference

type - the type of the new ObjectReference

value - the value of the new ObjectReference

Returns:

the instantiated ObjectReference

See Also:

• TaskService.newObjectReference()

updateTask

public Task updateTask(Task task)
                throws InvalidArgumentException,
TaskNotFoundException,
ConcurrencyException,
AttachmentPersistenceException,
ObjectReferencePersistenceException,
ClassificationNotFoundException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException

Description copied from interface: TaskService

Update a Task.

Specified by:

updateTask in interface TaskService

Parameters:

task - the Task to be updated

Returns:

the updated Task

Throws:

InvalidArgumentException - if the Task to be updated contains invalid properties like e.g. invalid secondaryObjectReferences

TaskNotFoundException - if the Task isn't found in the database by its id

ConcurrencyException - if the Task has been updated by another user in the meantime; that's the case if the given modified timestamp differs from the one in the database

AttachmentPersistenceException - if an Attachment with the same id was added to the Task multiple times without using Task.addAttachment(Attachment)

ObjectReferencePersistenceException - if an ObjectReference with the same id was added to the Task multiple times without using TaskSummary.addSecondaryObjectReference(ObjectReference)

ClassificationNotFoundException - if the classificationSummary of the updated Task refers to a Classification that can't be found

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

InvalidTaskStateException - if an attempt is made to change the owner of the Task that state isn't TaskState.READY

transferTasks

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

Description copied from interface: TaskService

Transfers a List of Tasks to another Workbasket.

The transfer resets isRead and sets isTransferred if setTransferFlag is true. Exceptions will be thrown if the caller got no WorkbasketPermission on the target or if the target Workbasket doesn't exist. Other Exceptions will be stored and returned in the end.

Specified by:

transferTasks in interface TaskService

Parameters:

destinationWorkbasketId - id of the target Workbasket

taskIds - List of source Tasks which will be moved

setTransferFlag - controls whether to set isTransferred or not

Returns:

Bulkresult with ids and Error for each failed transactions

Throws:

InvalidArgumentException - if the method parameters are empty or NULL

WorkbasketNotFoundException - if the target Workbasket can't be found

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the source Workbasket or no WorkbasketPermission.TRANSFER for the target Workbasket

transferTasks

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

Description copied from interface: TaskService

Transfers a List of Tasks to another Workbasket.

The transfer resets isRead and sets isTransferred if setTransferFlag is true. Exceptions will be thrown if the caller got no WorkbasketPermission on the target Workbasket or if it doesn't exist. Other Exceptions will be stored and returned in the end.

Specified by:

transferTasks in interface TaskService

Parameters:

destinationWorkbasketKey - target key

destinationWorkbasketDomain - target domain

taskIds - List of ids of source Tasks which will be moved

setTransferFlag - controls whether to set isTransferred or not

Returns:

BulkResult with ids and Error for each failed transactions

Throws:

InvalidArgumentException - if the method parameters are empty or NULL

WorkbasketNotFoundException - if the target Workbasket can't be found

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the source Workbasket or no WorkbasketPermission.TRANSFER for the target Workbasket

transferTasksWithOwner

public BulkOperationResults<String,TaskanaException> transferTasksWithOwner(String destinationWorkbasketId,
 List<String> taskIds,
 String owner,
 boolean setTransferFlag)
                                                                     throws InvalidArgumentException,
WorkbasketNotFoundException,
NotAuthorizedOnWorkbasketException

Description copied from interface: TaskService

Transfers a List of Tasks to another Workbasket and sets the owner of the Tasks.

The transfer resets isRead and sets isTransferred if setTransferFlag is true. Exceptions will be thrown if the caller got no WorkbasketPermission on the target or if the target Workbasket doesn't exist. Other Exceptions will be stored and returned in the end.

Specified by:

transferTasksWithOwner in interface TaskService

Parameters:

destinationWorkbasketId - id of the target Workbasket

taskIds - List of source Tasks which will be moved

owner - the owner of the Tasks after they have been transferred

setTransferFlag - controls whether to set isTransferred or not

Returns:

Bulkresult with ids and Error for each failed transactions

Throws:

InvalidArgumentException - if the method parameters are empty or NULL

WorkbasketNotFoundException - if the target Workbasket can't be found

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the source Workbasket or no WorkbasketPermission.TRANSFER for the target Workbasket

transferTasksWithOwner

public BulkOperationResults<String,TaskanaException> transferTasksWithOwner(String destinationWorkbasketKey,
 String destinationWorkbasketDomain,
 List<String> taskIds,
 String owner,
 boolean setTransferFlag)
                                                                     throws InvalidArgumentException,
WorkbasketNotFoundException,
NotAuthorizedOnWorkbasketException

Description copied from interface: TaskService

Transfers a List of Tasks to another Workbasket and sets the owner of the Tasks.

The transfer resets isRead and sets isTransferred if setTransferFlag is true. Exceptions will be thrown if the caller got no WorkbasketPermission on the target Workbasket or if it doesn't exist. Other Exceptions will be stored and returned in the end.

Specified by:

transferTasksWithOwner in interface TaskService

Parameters:

destinationWorkbasketKey - target key

destinationWorkbasketDomain - target domain

taskIds - List of ids of source Tasks which will be moved

owner - the new owner of the transferred tasks

setTransferFlag - controls whether to set isTransferred or not

Returns:

BulkResult with ids and Error for each failed transactions

Throws:

InvalidArgumentException - if the method parameters are empty or NULL

WorkbasketNotFoundException - if the target Workbasket can't be found

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the source Workbasket or no WorkbasketPermission.TRANSFER for the target Workbasket

deleteTask

public void deleteTask(String taskId)
                throws TaskNotFoundException,
NotAuthorizedException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException,
InvalidCallbackStateException

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 doesn't refer to an existing Task

NotAuthorizedException - if the current user isn't member of TaskanaRole.ADMIN

NotAuthorizedOnWorkbasketException - If the current user doesn't have correct permission

InvalidTaskStateException - If the state of the referenced Task isn't one of the TaskState.END_STATES

InvalidCallbackStateException - the Callback State of the Task is CallbackState.CALLBACK_PROCESSING_REQUIRED

forceDeleteTask

public void forceDeleteTask(String taskId)
                     throws TaskNotFoundException,
NotAuthorizedException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException,
InvalidCallbackStateException

Description copied from interface: TaskService

Deletes the Task with the given id even if it isn't completed.

Specified by:

forceDeleteTask in interface TaskService

Parameters:

taskId - The id of the Task to delete

Throws:

TaskNotFoundException - if the given id doesn't refer to an existing Task

NotAuthorizedException - if the current user isn't member of TaskanaRole.ADMIN

NotAuthorizedOnWorkbasketException - If the current user doesn't have correct permissions

InvalidTaskStateException - if the state of the referenced Task isn't TaskState.TERMINATED or TaskState.CANCELLED

InvalidCallbackStateException - the Callback State of the Task is CallbackState.CALLBACK_PROCESSING_REQUIRED

selectAndClaim

public Optional<Task> selectAndClaim(TaskQuery taskQuery)
                              throws NotAuthorizedOnWorkbasketException

Description copied from interface: TaskService

Selects and claims the first Task which is returned by the TaskQuery.

Specified by:

selectAndClaim in interface TaskService

Parameters:

taskQuery - the TaskQuery

Returns:

the Task that got selected and claimed

Throws:

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

deleteTasks

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

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 each id and Exception for each failed deletion

Throws:

InvalidArgumentException - if the tasks parameter contains NULL values

NotAuthorizedException - if the current user isn't member of TaskanaRole.ADMIN

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 - ids of the Tasks which should be completed

Returns:

the result of the operations with each id and Exception for each failed completion

Throws:

InvalidArgumentException - If the taskIds parameter is NULL

forceCompleteTasks

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

Description copied from interface: TaskService

Completes each existing Task in the given List in every case, independent of the owner or state of the Task.

If the Task is already completed, the Task stays unchanged.

Specified by:

forceCompleteTasks in interface TaskService

Parameters:

taskIds - id of the Tasks which should be completed

Returns:

the result of the operations with ids and Exception for each failed completion

Throws:

InvalidArgumentException - If the taskIds parameter is NULL

updateTasks

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

Description copied from interface: TaskService

Updates specified TaskCustomFields of Tasks associated with the given primaryObjRef. Tasks in Workbaskets without EDITTASKS permission will be ignored and not updated.

Specified by:

updateTasks in interface TaskService

Parameters:

selectionCriteria - the primaryObjRef of the searched-for Tasks.

customFieldsToUpdate - a Map that contains as key the identification of the TaskCustomField and as value the corresponding new value of that TaskCustomField

Returns:

a List of the ids of all modified Tasks

Throws:

InvalidArgumentException - if the given selectionCriteria is invalid or the given customFieldsToUpdate are NULL or empty

See Also:

• TaskService.updateTasks(List, Map)

updateTasks

public List<String> updateTasks(List<String> taskIds,
 Map<TaskCustomField,String> customFieldsToUpdate)
                         throws InvalidArgumentException

Description copied from interface: TaskService

Updates specified TaskCustomFields for all given Tasks.

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 TaskCustomField and as value the corresponding new value of that TaskCustomField

Returns:

a list of the ids of all modified Tasks

Throws:

InvalidArgumentException - if the given customFieldsToUpdate are NULL or empty

See Also:

• TaskService.updateTasks(ObjectReference, Map)

createTaskComment

public TaskComment createTaskComment(TaskComment taskComment)
                              throws TaskNotFoundException,
InvalidArgumentException,
NotAuthorizedOnWorkbasketException

Description copied from interface: TaskService

Inserts the specified TaskComment into the database.

Specified by:

createTaskComment in interface TaskService

Parameters:

taskComment - the TaskComment to be created

Returns:

the created TaskComment

Throws:

TaskNotFoundException - if the given taskId doesn't refer to an existing Task

InvalidArgumentException - if the id of the provided TaskComment is neither NULL nor empty

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket of the commented Task.

updateTaskComment

public TaskComment updateTaskComment(TaskComment taskComment)
                              throws ConcurrencyException,
TaskCommentNotFoundException,
TaskNotFoundException,
InvalidArgumentException,
NotAuthorizedOnTaskCommentException,
NotAuthorizedOnWorkbasketException

Description copied from interface: TaskService

Updates the specified TaskComment.

Specified by:

updateTaskComment in interface TaskService

Parameters:

taskComment - the TaskComment to be updated in the database

Returns:

the updated TaskComment

Throws:

ConcurrencyException - if an attempt is made to update the TaskComment and another user updated it already; that's the case if the given modified timestamp differs from the one in the database

TaskCommentNotFoundException - if the id of the specified TaskComment doesn't refer to an existing TaskComment

TaskNotFoundException - if the taskId doesn't refer to an existing Task

InvalidArgumentException - if the id of the specified TaskComment is NULL or empty

NotAuthorizedOnTaskCommentException - If the current user doesn't have correct permissions

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket of the commented Task.

deleteTaskComment

public void deleteTaskComment(String taskCommentId)
                       throws TaskCommentNotFoundException,
TaskNotFoundException,
InvalidArgumentException,
NotAuthorizedOnTaskCommentException,
NotAuthorizedOnWorkbasketException

Description copied from interface: TaskService

Deletes the TaskComment with the given id.

Specified by:

deleteTaskComment in interface TaskService

Parameters:

taskCommentId - the id of the TaskComment to delete

Throws:

TaskCommentNotFoundException - if the given taskCommentId doesn't refer to an existing TaskComment

TaskNotFoundException - if the taskId of the TaskComment doesn't refer to an existing Task

InvalidArgumentException - if the taskCommentId is NULL or empty

NotAuthorizedOnTaskCommentException - if the current user is not the creator of the TaskComment.

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the commented Task is in

getTaskComment

public TaskComment getTaskComment(String taskCommentid)
                           throws TaskCommentNotFoundException,
TaskNotFoundException,
InvalidArgumentException,
NotAuthorizedOnWorkbasketException

Description copied from interface: TaskService

Retrieves the TaskComment with the given id.

Specified by:

getTaskComment in interface TaskService

Parameters:

taskCommentid - the id of the TaskComment which should be retrieved

Returns:

the TaskComment identified by taskCommentId

Throws:

TaskCommentNotFoundException - if the given taskCommentId doesn't refer to an existing TaskComment

TaskNotFoundException - if the taskId of the TaskComment doesn't refer to an existing Task

InvalidArgumentException - if the given taskCommentId is NULL or empty

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket of the commented Task

getTaskComments

public List<TaskComment> getTaskComments(String taskId)
                                  throws TaskNotFoundException,
NotAuthorizedOnWorkbasketException

Description copied from interface: TaskService

Retrieves the List of TaskComments for the Task with given id.

Specified by:

getTaskComments in interface TaskService

Parameters:

taskId - the id of the Task for which all TaskComments should be retrieved

Returns:

the List of TaskComments attached to the specified Task

Throws:

TaskNotFoundException - if the given taskId doesn't refer to an existing Task

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket of the commented Task

setCallbackStateForTasks

public BulkOperationResults<String,TaskanaException> setCallbackStateForTasks(List<String> externalIds,
 CallbackState state)

Description copied from interface: TaskService

Sets the specified CallbackState 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 externalIds of the Tasks on which the CallbackState is set

state - the CallbackState that is to be set on the Tasks

Returns:

the result of the operations with ids and Exception for each failed operation

setOwnerOfTasks

public BulkOperationResults<String,TaskanaException> setOwnerOfTasks(String owner,
 List<String> taskIds)

Description copied from interface: TaskService

Sets the owner on a List of Tasks.

The owner will only be set on Tasks that are in TaskState.READY.

Specified by:

setOwnerOfTasks in interface TaskService

Parameters:

owner - the new owner of the Tasks

taskIds - the ids of the Tasks on which the owner is to be set

Returns:

the result of the operations with ids 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 Instant on a List of Tasks.

Only Tasks in state TaskState.READY and TaskState.CLAIMED will be affected by this method. On each Task, the corresponding due Instant is set according to the shortest serviceLevel in the Classification of the Task and its Attachments.

Specified by:

setPlannedPropertyOfTasks in interface TaskService

Parameters:

planned - the new planned Instant of the Tasks

argTaskIds - the ids of the Tasks on which the new planned Instant is to be set

Returns:

the result of the operations with ids and Exception for each failed Task update

cancelTask

public Task cancelTask(String taskId)
                throws TaskNotFoundException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException

Description copied from interface: TaskService

Cancels the Task with the given id.

Cancellation means a Task is obsolete from a business perspective and doesn't need to be completed anymore.

Specified by:

cancelTask in interface TaskService

Parameters:

taskId - the id of the Task to cancel

Returns:

the updated Task

Throws:

TaskNotFoundException - if the Task with taskId wasn't found

NotAuthorizedOnWorkbasketException - if the current user has no WorkbasketPermission.READ for the Workbasket the Task is in

InvalidTaskStateException - if the Task isn't in TaskState.READY or TaskState.CLAIMED

terminateTask

public Task terminateTask(String taskId)
                   throws TaskNotFoundException,
NotAuthorizedException,
NotAuthorizedOnWorkbasketException,
InvalidTaskStateException

Description copied from interface: TaskService

Terminates a Task. Termination is an administrative action to complete a Task.

This is typically done by administration to correct any technical issue.

Specified by:

terminateTask in interface TaskService

Parameters:

taskId - the id of the Task to terminate

Returns:

the updated Task

Throws:

TaskNotFoundException - if the Task with taskId wasn't found

NotAuthorizedException - if the current user isn't member of TaskanaRole.ADMIN or TaskanaRole.TASK_ADMIN

NotAuthorizedOnWorkbasketException - If the current user doesn't have the correct permission

InvalidTaskStateException - if the Task isn't in TaskState.READY or TaskState.CLAIMED

findTasksIdsAffectedByClassificationChange

public List<String> findTasksIdsAffectedByClassificationChange(String classificationId)

refreshPriorityAndDueDatesOfTasksOnClassificationUpdate

public void refreshPriorityAndDueDatesOfTasksOnClassificationUpdate(List<String> taskIds,
 boolean serviceLevelChanged,
 boolean priorityChanged)