Package pro.taskana.task.rest

Class TaskController

java.lang.Object

pro.taskana.common.rest.AbstractPagingController

pro.taskana.task.rest.TaskController

@RestController
@EnableHypermediaSupport(type=HAL)
public class TaskController
extends AbstractPagingController

Controller for all Task related endpoints.

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<TaskRepresentationModel>	cancelClaimTask(String taskId)
org.springframework.http.ResponseEntity<TaskRepresentationModel>	claimTask(String taskId, String userName)
org.springframework.http.ResponseEntity<TaskRepresentationModel>	completeTask(String taskId)
org.springframework.http.ResponseEntity<TaskRepresentationModel>	createTask(TaskRepresentationModel taskRepresentationModel)
org.springframework.http.ResponseEntity<TaskRepresentationModel>	deleteTask(String taskId)
org.springframework.http.ResponseEntity<TaskanaPagedModel<TaskSummaryRepresentationModel>>	deleteTasks(org.springframework.util.MultiValueMap<String,String> params)
org.springframework.http.ResponseEntity<TaskRepresentationModel>	getTask(String taskId)
org.springframework.http.ResponseEntity<TaskanaPagedModel<TaskSummaryRepresentationModel>>	getTasks(org.springframework.util.MultiValueMap<String,String> params)
org.springframework.http.ResponseEntity<TaskRepresentationModel>	selectAndClaimTask(org.springframework.util.MultiValueMap<String,String> params)
org.springframework.http.ResponseEntity<TaskRepresentationModel>	transferTask(String taskId, String workbasketId)
org.springframework.http.ResponseEntity<TaskRepresentationModel>	updateTask(String taskId, TaskRepresentationModel taskRepresentationModel)

Methods inherited from class pro.taskana.common.rest.AbstractPagingController

extractCommaSeparatedFields, getPageMetadata, getQueryList, initPageMetadata, initPageMetadata, validateNoInvalidParameterIsLeft

Methods inherited from class java.lang.Object

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

Method Detail

getTasks

@GetMapping(path="/api/v1/tasks")
@Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskanaPagedModel<TaskSummaryRepresentationModel>> getTasks(@RequestParam
                                                                                                           org.springframework.util.MultiValueMap<String,String> params)
                                                                                                    throws pro.taskana.common.api.exceptions.InvalidArgumentException

Throws:

pro.taskana.common.api.exceptions.InvalidArgumentException

deleteTasks

@DeleteMapping(path="/api/v1/tasks")
@Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskanaPagedModel<TaskSummaryRepresentationModel>> deleteTasks(@RequestParam
                                                                                                              org.springframework.util.MultiValueMap<String,String> params)
                                                                                                       throws pro.taskana.common.api.exceptions.InvalidArgumentException,
                                                                                                              pro.taskana.common.api.exceptions.NotAuthorizedException

Throws:

pro.taskana.common.api.exceptions.InvalidArgumentException

pro.taskana.common.api.exceptions.NotAuthorizedException

getTask

@GetMapping(path="/api/v1/tasks/{taskId}")
@Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskRepresentationModel> getTask(@PathVariable
                                                                                String taskId)
                                                                         throws pro.taskana.task.api.exceptions.TaskNotFoundException,
                                                                                pro.taskana.common.api.exceptions.NotAuthorizedException

Throws:

pro.taskana.task.api.exceptions.TaskNotFoundException

pro.taskana.common.api.exceptions.NotAuthorizedException

claimTask

@PostMapping(path="/api/v1/tasks/{taskId}/claim")
@Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskRepresentationModel> claimTask(@PathVariable
                                                                                  String taskId,
                                                                                  @RequestBody
                                                                                  String userName)
                                                                           throws pro.taskana.task.api.exceptions.TaskNotFoundException,
                                                                                  pro.taskana.task.api.exceptions.InvalidStateException,
                                                                                  pro.taskana.task.api.exceptions.InvalidOwnerException,
                                                                                  pro.taskana.common.api.exceptions.NotAuthorizedException

Throws:

pro.taskana.task.api.exceptions.TaskNotFoundException

pro.taskana.task.api.exceptions.InvalidStateException

pro.taskana.task.api.exceptions.InvalidOwnerException

pro.taskana.common.api.exceptions.NotAuthorizedException

selectAndClaimTask

@PostMapping(path="/api/v1/tasks/select-and-claim")
@Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskRepresentationModel> selectAndClaimTask(@RequestParam
                                                                                           org.springframework.util.MultiValueMap<String,String> params)
                                                                                    throws pro.taskana.task.api.exceptions.InvalidOwnerException,
                                                                                           pro.taskana.common.api.exceptions.NotAuthorizedException,
                                                                                           pro.taskana.common.api.exceptions.InvalidArgumentException

Throws:

pro.taskana.task.api.exceptions.InvalidOwnerException

pro.taskana.common.api.exceptions.NotAuthorizedException

pro.taskana.common.api.exceptions.InvalidArgumentException

cancelClaimTask

@DeleteMapping(path="/api/v1/tasks/{taskId}/claim")
@Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskRepresentationModel> cancelClaimTask(@PathVariable
                                                                                        String taskId)
                                                                                 throws pro.taskana.task.api.exceptions.TaskNotFoundException,
                                                                                        pro.taskana.task.api.exceptions.InvalidStateException,
                                                                                        pro.taskana.task.api.exceptions.InvalidOwnerException,
                                                                                        pro.taskana.common.api.exceptions.NotAuthorizedException

Throws:

pro.taskana.task.api.exceptions.TaskNotFoundException

pro.taskana.task.api.exceptions.InvalidStateException

pro.taskana.task.api.exceptions.InvalidOwnerException

pro.taskana.common.api.exceptions.NotAuthorizedException

completeTask

@PostMapping(path="/api/v1/tasks/{taskId}/complete")
@Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskRepresentationModel> completeTask(@PathVariable
                                                                                     String taskId)
                                                                              throws pro.taskana.task.api.exceptions.TaskNotFoundException,
                                                                                     pro.taskana.task.api.exceptions.InvalidOwnerException,
                                                                                     pro.taskana.task.api.exceptions.InvalidStateException,
                                                                                     pro.taskana.common.api.exceptions.NotAuthorizedException

Throws:

pro.taskana.task.api.exceptions.TaskNotFoundException

pro.taskana.task.api.exceptions.InvalidOwnerException

pro.taskana.task.api.exceptions.InvalidStateException

pro.taskana.common.api.exceptions.NotAuthorizedException

deleteTask

@DeleteMapping(path="/api/v1/tasks/{taskId}")
@Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskRepresentationModel> deleteTask(@PathVariable
                                                                                   String taskId)
                                                                            throws pro.taskana.task.api.exceptions.TaskNotFoundException,
                                                                                   pro.taskana.task.api.exceptions.InvalidStateException,
                                                                                   pro.taskana.common.api.exceptions.NotAuthorizedException

Throws:

pro.taskana.task.api.exceptions.TaskNotFoundException

pro.taskana.task.api.exceptions.InvalidStateException

pro.taskana.common.api.exceptions.NotAuthorizedException

createTask

@PostMapping(path="/api/v1/tasks")
@Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskRepresentationModel> createTask(@RequestBody
                                                                                   TaskRepresentationModel taskRepresentationModel)
                                                                            throws pro.taskana.workbasket.api.exceptions.WorkbasketNotFoundException,
                                                                                   pro.taskana.classification.api.exceptions.ClassificationNotFoundException,
                                                                                   pro.taskana.common.api.exceptions.NotAuthorizedException,
                                                                                   pro.taskana.task.api.exceptions.TaskAlreadyExistException,
                                                                                   pro.taskana.common.api.exceptions.InvalidArgumentException

Throws:

pro.taskana.workbasket.api.exceptions.WorkbasketNotFoundException

pro.taskana.classification.api.exceptions.ClassificationNotFoundException

pro.taskana.common.api.exceptions.NotAuthorizedException

pro.taskana.task.api.exceptions.TaskAlreadyExistException

pro.taskana.common.api.exceptions.InvalidArgumentException

transferTask

@PostMapping(path="/api/v1/tasks/{taskId}/transfer/{workbasketId}")
@Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskRepresentationModel> transferTask(@PathVariable
                                                                                     String taskId,
                                                                                     @PathVariable
                                                                                     String workbasketId)
                                                                              throws pro.taskana.task.api.exceptions.TaskNotFoundException,
                                                                                     pro.taskana.workbasket.api.exceptions.WorkbasketNotFoundException,
                                                                                     pro.taskana.common.api.exceptions.NotAuthorizedException,
                                                                                     pro.taskana.task.api.exceptions.InvalidStateException

Throws:

pro.taskana.task.api.exceptions.TaskNotFoundException

pro.taskana.workbasket.api.exceptions.WorkbasketNotFoundException

pro.taskana.common.api.exceptions.NotAuthorizedException

pro.taskana.task.api.exceptions.InvalidStateException

updateTask

@PutMapping(path="/api/v1/tasks/{taskId}")
@Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskRepresentationModel> updateTask(@PathVariable("taskId")
                                                                                   String taskId,
                                                                                   @RequestBody
                                                                                   TaskRepresentationModel taskRepresentationModel)
                                                                            throws pro.taskana.task.api.exceptions.TaskNotFoundException,
                                                                                   pro.taskana.classification.api.exceptions.ClassificationNotFoundException,
                                                                                   pro.taskana.common.api.exceptions.InvalidArgumentException,
                                                                                   pro.taskana.common.api.exceptions.ConcurrencyException,
                                                                                   pro.taskana.common.api.exceptions.NotAuthorizedException,
                                                                                   pro.taskana.task.api.exceptions.AttachmentPersistenceException,
                                                                                   pro.taskana.task.api.exceptions.InvalidStateException

Throws:

pro.taskana.task.api.exceptions.TaskNotFoundException

pro.taskana.classification.api.exceptions.ClassificationNotFoundException

pro.taskana.common.api.exceptions.InvalidArgumentException

pro.taskana.common.api.exceptions.ConcurrencyException

pro.taskana.common.api.exceptions.NotAuthorizedException

pro.taskana.task.api.exceptions.AttachmentPersistenceException

pro.taskana.task.api.exceptions.InvalidStateException