pro.taskana.rest

Class TaskController

java.lang.Object

pro.taskana.rest.AbstractPagingController

pro.taskana.rest.TaskController

@RestController
 @EnableHypermediaSupport(type=HAL)
 @RequestMapping(path="/v1/tasks",
                produces="application/hal+json")
public class TaskController
extends AbstractPagingController

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<TaskResource>	claimTask(String taskId, String userName)
org.springframework.http.ResponseEntity<TaskResource>	completeTask(String taskId)
org.springframework.http.ResponseEntity<TaskResource>	createTask(TaskResource taskResource)
org.springframework.http.ResponseEntity<TaskResource>	deleteTask(String taskId)
org.springframework.http.ResponseEntity<TaskResource>	getTask(String taskId)
org.springframework.http.ResponseEntity<org.springframework.hateoas.PagedResources<TaskSummaryResource>>	getTasks(org.springframework.util.MultiValueMap<String,String> params)
org.springframework.http.ResponseEntity<TaskResource>	transferTask(String taskId, String workbasketId)
org.springframework.http.ResponseEntity<TaskResource>	updateTask(String taskId, TaskResource taskResource)

Methods inherited from class pro.taskana.rest.AbstractPagingController

extractCommaSeparatedFields, initPageMetadata, validateNoInvalidParameterIsLeft

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<org.springframework.hateoas.PagedResources<TaskSummaryResource>> getTasks(@RequestParam
                                                                                                                                                                                                                          org.springframework.util.MultiValueMap<String,String> params)
                                                                                                                                                                                                                   throws pro.taskana.exceptions.InvalidArgumentException

Throws:

pro.taskana.exceptions.InvalidArgumentException

getTask

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

Throws:

pro.taskana.exceptions.TaskNotFoundException

pro.taskana.exceptions.NotAuthorizedException

claimTask

@PostMapping(path="/{taskId}/claim")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskResource> claimTask(@PathVariable
                                                                                                                                                                   String taskId,
                                                                                                                                                                   @RequestBody
                                                                                                                                                                   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<TaskResource> completeTask(@PathVariable
                                                                                                                                                                                                          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

deleteTask

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

Throws:

pro.taskana.exceptions.TaskNotFoundException

pro.taskana.exceptions.InvalidStateException

pro.taskana.exceptions.NotAuthorizedException

createTask

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

Throws:

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.ClassificationNotFoundException

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.TaskAlreadyExistException

pro.taskana.exceptions.InvalidArgumentException

transferTask

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

Throws:

pro.taskana.exceptions.TaskNotFoundException

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.InvalidStateException

updateTask

@PutMapping(path="/{taskId}")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskResource> updateTask(@PathVariable(value="taskId")
                                                                                                                                                             String taskId,
                                                                                                                                                             @RequestBody
                                                                                                                                                             TaskResource taskResource)
                                                                                                                                                      throws pro.taskana.exceptions.TaskNotFoundException,
                                                                                                                                                             pro.taskana.exceptions.ClassificationNotFoundException,
                                                                                                                                                             pro.taskana.exceptions.InvalidArgumentException,
                                                                                                                                                             pro.taskana.exceptions.ConcurrencyException,
                                                                                                                                                             pro.taskana.exceptions.NotAuthorizedException,
                                                                                                                                                             pro.taskana.exceptions.AttachmentPersistenceException

Throws:

pro.taskana.exceptions.TaskNotFoundException

pro.taskana.exceptions.ClassificationNotFoundException

pro.taskana.exceptions.InvalidArgumentException

pro.taskana.exceptions.ConcurrencyException

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.AttachmentPersistenceException