pro.taskana.rest

Class WorkbasketController

java.lang.Object

pro.taskana.rest.WorkbasketController

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

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<?>	deleteWorkbasket(java.lang.String workbasketId)
org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<DistributionTargetResource>>	getDistributionTargets(java.lang.String workbasketId)
org.springframework.http.ResponseEntity<java.util.List<java.lang.String>>	getDomains()
org.springframework.http.ResponseEntity<WorkbasketResource>	getWorkbasket(java.lang.String workbasketId)
org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<WorkbasketAccessItemResource>>	getWorkbasketAccessItems(java.lang.String workbasketId)
org.springframework.http.ResponseEntity<org.springframework.hateoas.PagedResources<WorkbasketSummaryResource>>	getWorkbaskets(java.lang.String sortBy, java.lang.String order, java.lang.String name, java.lang.String nameLike, java.lang.String key, java.lang.String keyLike, java.lang.String descLike, java.lang.String owner, java.lang.String ownerLike, java.lang.String type, java.lang.String requiredPermission, java.lang.String page, java.lang.String pagesize)
org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<DistributionTargetResource>>	setDistributionTargetsForWorkbasketId(java.lang.String sourceWorkbasketId, java.util.List<java.lang.String> targetWorkbasketIds)
org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<WorkbasketAccessItemResource>>	setWorkbasketAccessItems(java.lang.String workbasketId, java.util.List<WorkbasketAccessItemResource> workbasketAccessResourceItems)
org.springframework.http.ResponseEntity<WorkbasketResource>	updateWorkbasket(java.lang.String workbasketId, WorkbasketResource workbasketResource)

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(value="sortBy",defaultValue="name",required=false)
                                                                                                                                                                                                                                      java.lang.String sortBy,
                                                                                                                                                                                                                                      @RequestParam(value="order",defaultValue="asc",required=false)
                                                                                                                                                                                                                                      java.lang.String order,
                                                                                                                                                                                                                                      @RequestParam(value="name",required=false)
                                                                                                                                                                                                                                      java.lang.String name,
                                                                                                                                                                                                                                      @RequestParam(value="nameLike",required=false)
                                                                                                                                                                                                                                      java.lang.String nameLike,
                                                                                                                                                                                                                                      @RequestParam(value="key",required=false)
                                                                                                                                                                                                                                      java.lang.String key,
                                                                                                                                                                                                                                      @RequestParam(value="keyLike",required=false)
                                                                                                                                                                                                                                      java.lang.String keyLike,
                                                                                                                                                                                                                                      @RequestParam(value="descLike",required=false)
                                                                                                                                                                                                                                      java.lang.String descLike,
                                                                                                                                                                                                                                      @RequestParam(value="owner",required=false)
                                                                                                                                                                                                                                      java.lang.String owner,
                                                                                                                                                                                                                                      @RequestParam(value="ownerLike",required=false)
                                                                                                                                                                                                                                      java.lang.String ownerLike,
                                                                                                                                                                                                                                      @RequestParam(value="type",required=false)
                                                                                                                                                                                                                                      java.lang.String type,
                                                                                                                                                                                                                                      @RequestParam(value="requiredPermission",required=false)
                                                                                                                                                                                                                                      java.lang.String requiredPermission,
                                                                                                                                                                                                                                      @RequestParam(value="page",required=false)
                                                                                                                                                                                                                                      java.lang.String page,
                                                                                                                                                                                                                                      @RequestParam(value="pagesize",required=false)
                                                                                                                                                                                                                                      java.lang.String pagesize)
                                                                                                                                                                                                                               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")
                                                                                                                                                                                                          java.lang.String workbasketId)
                                                                                                                                                                                                   throws pro.taskana.exceptions.WorkbasketNotFoundException,
                                                                                                                                                                                                          pro.taskana.exceptions.NotAuthorizedException

Throws:

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.NotAuthorizedException

deleteWorkbasket

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

Throws:

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.WorkbasketInUseException

pro.taskana.exceptions.InvalidArgumentException

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")
                                                                                                                                                                               java.lang.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")
                                                                                                                                                                                                                                                                                            java.lang.String workbasketId)
                                                                                                                                                                                                                                                                                     throws pro.taskana.exceptions.NotAuthorizedException,
                                                                                                                                                                                                                                                                                            pro.taskana.exceptions.WorkbasketNotFoundException

Throws:

pro.taskana.exceptions.NotAuthorizedException

pro.taskana.exceptions.WorkbasketNotFoundException

getDomains

@GetMapping(path="/domains")
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<java.util.List<java.lang.String>> getDomains()

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")
                                                                                                                                                                                                                                                               java.lang.String workbasketId,
                                                                                                                                                                                                                                                               @RequestBody
                                                                                                                                                                                                                                                               java.util.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}/distributiontargets")
 @Transactional(readOnly=true,
               rollbackFor=java.lang.Exception.class)
public org.springframework.http.ResponseEntity<org.springframework.hateoas.Resources<DistributionTargetResource>> getDistributionTargets(@PathVariable(value="workbasketId")
                                                                                                                                                                                                                                                                                      java.lang.String workbasketId)
                                                                                                                                                                                                                                                                               throws pro.taskana.exceptions.WorkbasketNotFoundException,
                                                                                                                                                                                                                                                                                      pro.taskana.exceptions.NotAuthorizedException

Throws:

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.NotAuthorizedException

setDistributionTargetsForWorkbasketId

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

Throws:

pro.taskana.exceptions.WorkbasketNotFoundException

pro.taskana.exceptions.NotAuthorizedException