pro.taskana.rest

Class TaskController

java.lang.Object

pro.taskana.rest.TaskController

@RestController
 @RequestMapping(path="/v1/tasks",
                produces="application/json")
public class TaskController
extends java.lang.Object

Controller for all Task related endpoints.

Constructor Summary

Constructors

Constructor and Description
TaskController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<pro.taskana.Task>	claimTask(java.lang.String taskId, java.lang.String userName)
org.springframework.http.ResponseEntity<pro.taskana.Task>	completeTask(java.lang.String taskId)
org.springframework.http.ResponseEntity<pro.taskana.Task>	createTask(pro.taskana.Task task)
org.springframework.http.ResponseEntity<pro.taskana.Task>	getTask(java.lang.String taskId)
org.springframework.http.ResponseEntity<java.util.List<pro.taskana.TaskSummary>>	getTasks(org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> params)
org.springframework.http.ResponseEntity<java.util.List<pro.taskana.TaskSummary>>	getTasksByWorkbasketIdAndState(java.lang.String workbasketId, pro.taskana.TaskState taskState)
org.springframework.http.ResponseEntity<java.util.List<pro.taskana.TaskSummary>>	getTasksummariesByWorkbasketId(java.lang.String workbasketId)
org.springframework.http.ResponseEntity<pro.taskana.Task>	transferTask(java.lang.String taskId, java.lang.String workbasketKey)

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskController

public TaskController()

Method Detail

getTasks

@GetMapping
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<java.util.List<pro.taskana.TaskSummary>> getTasks(@RequestParam
                                                                                                                                                                                                  org.springframework.util.MultiValueMap<java.lang.String,java.lang.String> params)
                                                                                                                                                                                           throws pro.taskana.exceptions.NotAuthorizedException,
                                                                                                                                                                                                  pro.taskana.exceptions.InvalidArgumentException

Throws:

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.InvalidArgumentException

getTask

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

Throws:

pro.taskana.exceptions.TaskNotFoundException

pro.taskana.exceptions.NotAuthorizedException

getTasksByWorkbasketIdAndState

@GetMapping(path="/workbasket/{workbasketId}/state/{taskState}")
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<java.util.List<pro.taskana.TaskSummary>> getTasksByWorkbasketIdAndState(@PathVariable
                                                                                                                                                                                                                                                                             java.lang.String workbasketId,
                                                                                                                                                                                                                                                                             @PathVariable
                                                                                                                                                                                                                                                                             pro.taskana.TaskState taskState)

claimTask

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

Throws:

pro.taskana.exceptions.TaskNotFoundException

pro.taskana.exceptions.InvalidStateException

pro.taskana.exceptions.InvalidOwnerException

pro.taskana.exceptions.NotAuthorizedException

completeTask

@RequestMapping(method=POST,
                value="/{taskId}/complete")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<pro.taskana.Task> completeTask(@PathVariable
                                                                                                                                                                                                              java.lang.String taskId)
                                                                                                                                                                                                       throws pro.taskana.exceptions.TaskNotFoundException,
                                                                                                                                                                                                              pro.taskana.exceptions.InvalidOwnerException,
                                                                                                                                                                                                              pro.taskana.exceptions.InvalidStateException,
                                                                                                                                                                                                              pro.taskana.exceptions.NotAuthorizedException

Throws:

pro.taskana.exceptions.TaskNotFoundException

pro.taskana.exceptions.InvalidOwnerException

pro.taskana.exceptions.InvalidStateException

pro.taskana.exceptions.NotAuthorizedException

createTask

@RequestMapping(method=POST)
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<pro.taskana.Task> createTask(@RequestBody
                                                                                                                                                                pro.taskana.Task task)
                                                                                                                                                         throws pro.taskana.exceptions.WorkbasketNotFoundException,
                                                                                                                                                                pro.taskana.exceptions.ClassificationNotFoundException,
                                                                                                                                                                pro.taskana.exceptions.NotAuthorizedException,
                                                                                                                                                                pro.taskana.exceptions.TaskAlreadyExistException,
                                                                                                                                                                pro.taskana.exceptions.InvalidWorkbasketException,
                                                                                                                                                                pro.taskana.exceptions.InvalidArgumentException

Throws:

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.ClassificationNotFoundException

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.TaskAlreadyExistException

pro.taskana.exceptions.InvalidWorkbasketException

pro.taskana.exceptions.InvalidArgumentException

transferTask

@RequestMapping(path="/{taskId}/transfer/{workbasketKey}")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<pro.taskana.Task> transferTask(@PathVariable
                                                                                                                                                                                                java.lang.String taskId,
                                                                                                                                                                                                @PathVariable
                                                                                                                                                                                                java.lang.String workbasketKey)
                                                                                                                                                                                         throws pro.taskana.exceptions.TaskNotFoundException,
                                                                                                                                                                                                pro.taskana.exceptions.WorkbasketNotFoundException,
                                                                                                                                                                                                pro.taskana.exceptions.NotAuthorizedException,
                                                                                                                                                                                                pro.taskana.exceptions.InvalidWorkbasketException

Throws:

pro.taskana.exceptions.TaskNotFoundException

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.InvalidWorkbasketException

getTasksummariesByWorkbasketId

@GetMapping(path="/workbasket/{workbasketId}")
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<java.util.List<pro.taskana.TaskSummary>> getTasksummariesByWorkbasketId(@PathVariable
                                                                                                                                                                                                                                                           java.lang.String workbasketId)