pro.taskana.rest

Class ClassificationController

java.lang.Object

pro.taskana.rest.AbstractPagingController

pro.taskana.rest.ClassificationController

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

Controller for all Classification related endpoints.

Constructor Summary

Constructors

Constructor and Description
ClassificationController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<ClassificationResource>	createClassification(ClassificationResource resource)
org.springframework.http.ResponseEntity<?>	deleteClassification(String classificationId)
org.springframework.http.ResponseEntity<ClassificationResource>	getClassification(String classificationId)
org.springframework.http.ResponseEntity<org.springframework.hateoas.PagedResources<ClassificationSummaryResource>>	getClassifications(org.springframework.util.MultiValueMap<String,String> params)
org.springframework.http.ResponseEntity<ClassificationResource>	updateClassification(String classificationId, ClassificationResource resource)

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

ClassificationController

public ClassificationController()

Method Detail

getClassifications

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

Throws:

pro.taskana.exceptions.InvalidArgumentException

getClassification

@GetMapping(path="/{classificationId}")
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<ClassificationResource> getClassification(@PathVariable
                                                                                                                                                                                                                      String classificationId)
                                                                                                                                                                                                               throws pro.taskana.exceptions.ClassificationNotFoundException,
                                                                                                                                                                                                                      pro.taskana.exceptions.NotAuthorizedException,
                                                                                                                                                                                                                      pro.taskana.exceptions.ClassificationAlreadyExistException,
                                                                                                                                                                                                                      pro.taskana.exceptions.ConcurrencyException,
                                                                                                                                                                                                                      pro.taskana.exceptions.DomainNotFoundException,
                                                                                                                                                                                                                      pro.taskana.exceptions.InvalidArgumentException

Throws:

pro.taskana.exceptions.ClassificationNotFoundException

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.ClassificationAlreadyExistException

pro.taskana.exceptions.ConcurrencyException

pro.taskana.exceptions.DomainNotFoundException

pro.taskana.exceptions.InvalidArgumentException

createClassification

@PostMapping
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<ClassificationResource> createClassification(@RequestBody
                                                                                                                                                                ClassificationResource resource)
                                                                                                                                                         throws pro.taskana.exceptions.NotAuthorizedException,
                                                                                                                                                                pro.taskana.exceptions.ClassificationNotFoundException,
                                                                                                                                                                pro.taskana.exceptions.ClassificationAlreadyExistException,
                                                                                                                                                                pro.taskana.exceptions.ConcurrencyException,
                                                                                                                                                                pro.taskana.exceptions.DomainNotFoundException,
                                                                                                                                                                pro.taskana.exceptions.InvalidArgumentException

Throws:

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.ClassificationNotFoundException

pro.taskana.exceptions.ClassificationAlreadyExistException

pro.taskana.exceptions.ConcurrencyException

pro.taskana.exceptions.DomainNotFoundException

pro.taskana.exceptions.InvalidArgumentException

updateClassification

@PutMapping(path="/{classificationId}")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<ClassificationResource> updateClassification(@PathVariable(value="classificationId")
                                                                                                                                                                                           String classificationId,
                                                                                                                                                                                           @RequestBody
                                                                                                                                                                                           ClassificationResource resource)
                                                                                                                                                                                    throws pro.taskana.exceptions.NotAuthorizedException,
                                                                                                                                                                                           pro.taskana.exceptions.ClassificationNotFoundException,
                                                                                                                                                                                           pro.taskana.exceptions.ConcurrencyException,
                                                                                                                                                                                           pro.taskana.exceptions.ClassificationAlreadyExistException,
                                                                                                                                                                                           pro.taskana.exceptions.DomainNotFoundException,
                                                                                                                                                                                           pro.taskana.exceptions.InvalidArgumentException

Throws:

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.ClassificationNotFoundException

pro.taskana.exceptions.ConcurrencyException

pro.taskana.exceptions.ClassificationAlreadyExistException

pro.taskana.exceptions.DomainNotFoundException

pro.taskana.exceptions.InvalidArgumentException

deleteClassification

@DeleteMapping(path="/{classificationId}")
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<?> deleteClassification(@PathVariable
                                                                                                                                                                                                       String classificationId)
                                                                                                                                                                                                throws pro.taskana.exceptions.ClassificationNotFoundException,
                                                                                                                                                                                                       pro.taskana.exceptions.ClassificationInUseException,
                                                                                                                                                                                                       pro.taskana.exceptions.NotAuthorizedException

Throws:

pro.taskana.exceptions.ClassificationNotFoundException

pro.taskana.exceptions.ClassificationInUseException

pro.taskana.exceptions.NotAuthorizedException