Package pro.taskana.task.rest

Class TaskCommentController

java.lang.Object

pro.taskana.task.rest.TaskCommentController

@RestController
@EnableHypermediaSupport(type=HAL)
public class TaskCommentController
extends Object

Controller for all TaskComment related endpoints.

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<TaskCommentRepresentationModel>	createTaskComment(String taskId, TaskCommentRepresentationModel taskCommentRepresentationModel)
org.springframework.http.ResponseEntity<TaskCommentRepresentationModel>	deleteTaskComment(String taskCommentId)
org.springframework.http.ResponseEntity<TaskCommentRepresentationModel>	getTaskComment(String taskCommentId)
org.springframework.http.ResponseEntity<TaskanaPagedModel<TaskCommentRepresentationModel>>	getTaskComments(String taskId, org.springframework.util.MultiValueMap<String,String> params)
org.springframework.http.ResponseEntity<TaskCommentRepresentationModel>	updateTaskComment(String taskCommentId, TaskCommentRepresentationModel taskCommentRepresentationModel)

Methods inherited from class java.lang.Object

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

Method Detail

getTaskComment

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

Throws:

pro.taskana.common.api.exceptions.NotAuthorizedException

pro.taskana.task.api.exceptions.TaskNotFoundException

pro.taskana.task.api.exceptions.TaskCommentNotFoundException

pro.taskana.common.api.exceptions.InvalidArgumentException

getTaskComments

@GetMapping(path="/api/v1/tasks/{taskId}/comments")
@Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskanaPagedModel<TaskCommentRepresentationModel>> getTaskComments(@PathVariable
                                                                                                                  String taskId,
                                                                                                                  @RequestParam(required=false)
                                                                                                                  org.springframework.util.MultiValueMap<String,String> params)
                                                                                                           throws pro.taskana.common.api.exceptions.NotAuthorizedException,
                                                                                                                  pro.taskana.task.api.exceptions.TaskNotFoundException,
                                                                                                                  pro.taskana.common.api.exceptions.InvalidArgumentException

Throws:

pro.taskana.common.api.exceptions.NotAuthorizedException

pro.taskana.task.api.exceptions.TaskNotFoundException

pro.taskana.common.api.exceptions.InvalidArgumentException

deleteTaskComment

@DeleteMapping(path="/api/v1/tasks/comments/{taskCommentId}")
@Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskCommentRepresentationModel> deleteTaskComment(@PathVariable
                                                                                                 String taskCommentId)
                                                                                          throws pro.taskana.common.api.exceptions.NotAuthorizedException,
                                                                                                 pro.taskana.task.api.exceptions.TaskNotFoundException,
                                                                                                 pro.taskana.task.api.exceptions.TaskCommentNotFoundException,
                                                                                                 pro.taskana.common.api.exceptions.InvalidArgumentException

Throws:

pro.taskana.common.api.exceptions.NotAuthorizedException

pro.taskana.task.api.exceptions.TaskNotFoundException

pro.taskana.task.api.exceptions.TaskCommentNotFoundException

pro.taskana.common.api.exceptions.InvalidArgumentException

updateTaskComment

@PutMapping(path="/api/v1/tasks/comments/{taskCommentId}")
@Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskCommentRepresentationModel> updateTaskComment(@PathVariable
                                                                                                 String taskCommentId,
                                                                                                 @RequestBody
                                                                                                 TaskCommentRepresentationModel taskCommentRepresentationModel)
                                                                                          throws pro.taskana.common.api.exceptions.NotAuthorizedException,
                                                                                                 pro.taskana.task.api.exceptions.TaskNotFoundException,
                                                                                                 pro.taskana.task.api.exceptions.TaskCommentNotFoundException,
                                                                                                 pro.taskana.common.api.exceptions.InvalidArgumentException,
                                                                                                 pro.taskana.common.api.exceptions.ConcurrencyException

Throws:

pro.taskana.common.api.exceptions.NotAuthorizedException

pro.taskana.task.api.exceptions.TaskNotFoundException

pro.taskana.task.api.exceptions.TaskCommentNotFoundException

pro.taskana.common.api.exceptions.InvalidArgumentException

pro.taskana.common.api.exceptions.ConcurrencyException

createTaskComment

@PostMapping(path="/api/v1/tasks/{taskId}/comments")
@Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<TaskCommentRepresentationModel> createTaskComment(@PathVariable
                                                                                                 String taskId,
                                                                                                 @RequestBody
                                                                                                 TaskCommentRepresentationModel taskCommentRepresentationModel)
                                                                                          throws pro.taskana.common.api.exceptions.NotAuthorizedException,
                                                                                                 pro.taskana.common.api.exceptions.InvalidArgumentException,
                                                                                                 pro.taskana.task.api.exceptions.TaskNotFoundException

Throws:

pro.taskana.common.api.exceptions.NotAuthorizedException

pro.taskana.common.api.exceptions.InvalidArgumentException

pro.taskana.task.api.exceptions.TaskNotFoundException