pro.taskana.rest

Class WorkbasketController

java.lang.Object

pro.taskana.rest.AbstractPagingController

pro.taskana.rest.WorkbasketController

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

Controller for all Workbasket related endpoints.

Constructor Summary

Constructors

Constructor and Description
WorkbasketController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<WorkbasketResource>	createWorkbasket(WorkbasketResource workbasketResource)
org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<DistributionTargetResource>>	getDistributionTargets(String workbasketId)
org.springframework.http.ResponseEntity<WorkbasketResource>	getWorkbasket(String workbasketId)
org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<WorkbasketAccessItemResource>>	getWorkbasketAccessItems(String workbasketId)
org.springframework.http.ResponseEntity<org.springframework.hateoas.PagedResources<WorkbasketSummaryResource>>	getWorkbaskets(org.springframework.util.MultiValueMap<String,String> params)
org.springframework.http.ResponseEntity<?>	markWorkbasketForDeletion(String workbasketId)
org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<DistributionTargetResource>>	removeDistributionTargetForWorkbasketId(String targetWorkbasketId)
org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<DistributionTargetResource>>	setDistributionTargetsForWorkbasketId(String sourceWorkbasketId, List<String> targetWorkbasketIds)
org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<WorkbasketAccessItemResource>>	setWorkbasketAccessItems(String workbasketId, List<WorkbasketAccessItemResource> workbasketAccessResourceItems)
org.springframework.http.ResponseEntity<WorkbasketResource>	updateWorkbasket(String workbasketId, WorkbasketResource workbasketResource)

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

WorkbasketController

public WorkbasketController()

Method Detail

getWorkbaskets

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

Throws:

pro.taskana.exceptions.InvalidArgumentException

getWorkbasket

@GetMapping(path="/{workbasketId}")
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<WorkbasketResource> getWorkbasket(@PathVariable(value="workbasketId")
                                                                                                                                                                                                          String workbasketId)
                                                                                                                                                                                                   throws pro.taskana.exceptions.WorkbasketNotFoundException,
                                                                                                                                                                                                          pro.taskana.exceptions.NotAuthorizedException

Throws:

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.NotAuthorizedException

markWorkbasketForDeletion

@DeleteMapping(path="/{workbasketId}")
 @Transactional(rollbackFor=java.lang.Exception.class,
               noRollbackFor=pro.taskana.exceptions.WorkbasketNotFoundException.class)
public org.springframework.http.ResponseEntity<?> markWorkbasketForDeletion(@PathVariable(value="workbasketId")
                                                                                                                                                                                                                                                                 String workbasketId)
                                                                                                                                                                                                                                                          throws pro.taskana.exceptions.NotAuthorizedException,
                                                                                                                                                                                                                                                                 pro.taskana.exceptions.InvalidArgumentException,
                                                                                                                                                                                                                                                                 pro.taskana.exceptions.WorkbasketNotFoundException,
                                                                                                                                                                                                                                                                 pro.taskana.exceptions.WorkbasketInUseException

Throws:

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.InvalidArgumentException

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.WorkbasketInUseException

createWorkbasket

@PostMapping
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<WorkbasketResource> createWorkbasket(@RequestBody
                                                                                                                                                        WorkbasketResource workbasketResource)
                                                                                                                                                 throws pro.taskana.exceptions.InvalidWorkbasketException,
                                                                                                                                                        pro.taskana.exceptions.NotAuthorizedException,
                                                                                                                                                        pro.taskana.exceptions.WorkbasketAlreadyExistException,
                                                                                                                                                        pro.taskana.exceptions.WorkbasketNotFoundException,
                                                                                                                                                        pro.taskana.exceptions.DomainNotFoundException

Throws:

pro.taskana.exceptions.InvalidWorkbasketException

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.WorkbasketAlreadyExistException

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.DomainNotFoundException

updateWorkbasket

@PutMapping(path="/{workbasketId}")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<WorkbasketResource> updateWorkbasket(@PathVariable(value="workbasketId")
                                                                                                                                                                               String workbasketId,
                                                                                                                                                                               @RequestBody
                                                                                                                                                                               WorkbasketResource workbasketResource)
                                                                                                                                                                        throws pro.taskana.exceptions.InvalidWorkbasketException,
                                                                                                                                                                               pro.taskana.exceptions.WorkbasketNotFoundException,
                                                                                                                                                                               pro.taskana.exceptions.NotAuthorizedException

Throws:

pro.taskana.exceptions.InvalidWorkbasketException

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.NotAuthorizedException

getWorkbasketAccessItems

@GetMapping(path="/{workbasketId}/workbasketAccessItems")
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<WorkbasketAccessItemResource>> getWorkbasketAccessItems(@PathVariable(value="workbasketId")
                                                                                                                                                                                                                                                                                            String workbasketId)
                                                                                                                                                                                                                                                                                     throws pro.taskana.exceptions.NotAuthorizedException,
                                                                                                                                                                                                                                                                                            pro.taskana.exceptions.WorkbasketNotFoundException

Throws:

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.WorkbasketNotFoundException

setWorkbasketAccessItems

@PutMapping(value="/{workbasketId}/workbasketAccessItems")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<WorkbasketAccessItemResource>> setWorkbasketAccessItems(@PathVariable(value="workbasketId")
                                                                                                                                                                                                                                                               String workbasketId,
                                                                                                                                                                                                                                                               @RequestBody
                                                                                                                                                                                                                                                               List<WorkbasketAccessItemResource> workbasketAccessResourceItems)
                                                                                                                                                                                                                                                        throws pro.taskana.exceptions.NotAuthorizedException,
                                                                                                                                                                                                                                                               pro.taskana.exceptions.InvalidArgumentException,
                                                                                                                                                                                                                                                               pro.taskana.exceptions.WorkbasketNotFoundException

Throws:

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.InvalidArgumentException

pro.taskana.exceptions.WorkbasketNotFoundException

getDistributionTargets

@GetMapping(path="/{workbasketId}/distribution-targets")
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<DistributionTargetResource>> getDistributionTargets(@PathVariable(value="workbasketId")
                                                                                                                                                                                                                                                                                       String workbasketId)
                                                                                                                                                                                                                                                                                throws pro.taskana.exceptions.WorkbasketNotFoundException,
                                                                                                                                                                                                                                                                                       pro.taskana.exceptions.NotAuthorizedException

Throws:

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.NotAuthorizedException

setDistributionTargetsForWorkbasketId

@PutMapping(path="/{workbasketId}/distribution-targets")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<DistributionTargetResource>> setDistributionTargetsForWorkbasketId(@PathVariable(value="workbasketId")
                                                                                                                                                                                                                                                                        String sourceWorkbasketId,
                                                                                                                                                                                                                                                                        @RequestBody
                                                                                                                                                                                                                                                                        List<String> targetWorkbasketIds)
                                                                                                                                                                                                                                                                 throws pro.taskana.exceptions.WorkbasketNotFoundException,
                                                                                                                                                                                                                                                                        pro.taskana.exceptions.NotAuthorizedException

Throws:

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.NotAuthorizedException

removeDistributionTargetForWorkbasketId

@DeleteMapping(path="/distribution-targets/{workbasketId}")
 @Transactional(rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<DistributionTargetResource>> removeDistributionTargetForWorkbasketId(@PathVariable(value="workbasketId")
                                                                                                                                                                                                                                                                             String targetWorkbasketId)
                                                                                                                                                                                                                                                                      throws pro.taskana.exceptions.WorkbasketNotFoundException,
                                                                                                                                                                                                                                                                             pro.taskana.exceptions.NotAuthorizedException

Throws:

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.NotAuthorizedException