pro.taskana.classification.rest

Class ClassificationController

java.lang.Object

pro.taskana.common.rest.AbstractPagingController

pro.taskana.classification.rest.ClassificationController

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

Controller for all Classification related endpoints.

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<ClassificationRepresentationModel>	createClassification(ClassificationRepresentationModel resource)
org.springframework.http.ResponseEntity<ClassificationRepresentationModel>	deleteClassification(String classificationId)
org.springframework.http.ResponseEntity<ClassificationRepresentationModel>	getClassification(String classificationId)
org.springframework.http.ResponseEntity<TaskanaPagedModel<ClassificationSummaryRepresentationModel>>	getClassifications(org.springframework.util.MultiValueMap<String,String> params)
org.springframework.http.ResponseEntity<ClassificationRepresentationModel>	updateClassification(String classificationId, ClassificationRepresentationModel resource)

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

getClassifications

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

Throws:

pro.taskana.common.api.exceptions.InvalidArgumentException

getClassification

@GetMapping(path="/api/v1/classifications/{classificationId}",
            produces="application/hal+json")
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<ClassificationRepresentationModel> getClassification(@PathVariable
                                                                                                                                                                                                                                                                                                     String classificationId)
                                                                                                                                                                                                                                                                                              throws pro.taskana.classification.api.exceptions.ClassificationNotFoundException

Throws:

pro.taskana.classification.api.exceptions.ClassificationNotFoundException

createClassification

@PostMapping(path="/api/v1/classifications")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<ClassificationRepresentationModel> createClassification(@RequestBody
                                                                                                                                                                                                           ClassificationRepresentationModel resource)
                                                                                                                                                                                                    throws pro.taskana.common.api.exceptions.NotAuthorizedException,
                                                                                                                                                                                                           pro.taskana.classification.api.exceptions.ClassificationAlreadyExistException,
                                                                                                                                                                                                           pro.taskana.common.api.exceptions.DomainNotFoundException,
                                                                                                                                                                                                           pro.taskana.common.api.exceptions.InvalidArgumentException

Throws:

pro.taskana.common.api.exceptions.NotAuthorizedException

pro.taskana.classification.api.exceptions.ClassificationAlreadyExistException

pro.taskana.common.api.exceptions.DomainNotFoundException

pro.taskana.common.api.exceptions.InvalidArgumentException

updateClassification

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

Throws:

pro.taskana.common.api.exceptions.NotAuthorizedException

pro.taskana.classification.api.exceptions.ClassificationNotFoundException

pro.taskana.common.api.exceptions.ConcurrencyException

pro.taskana.common.api.exceptions.InvalidArgumentException

deleteClassification

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

Throws:

pro.taskana.classification.api.exceptions.ClassificationNotFoundException

pro.taskana.classification.api.exceptions.ClassificationInUseException

pro.taskana.common.api.exceptions.NotAuthorizedException