pro.taskana.rest

Class WorkbasketAccessItemController

java.lang.Object

pro.taskana.rest.AbstractPagingController

pro.taskana.rest.WorkbasketAccessItemController

@RestController
 @EnableHypermediaSupport(type=HAL)
 @RequestMapping(path="/v1/workbasket-access-items",
                produces="application/hal+json")
public class WorkbasketAccessItemController
extends AbstractPagingController

Controller for Workbasket access.

Constructor Summary

Constructors

Constructor and Description
WorkbasketAccessItemController()

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<org.springframework.hateoas.PagedResources<WorkbasketAccessItemResource>>	getWorkbasketAccessItems(org.springframework.util.MultiValueMap<String,String> params) This GET method return all workbasketAccessItems that correspond the given data.
org.springframework.http.ResponseEntity<Void>	removeWorkbasketAccessItems(String accessId) This DELETE method delete all workbasketAccessItems that correspond the given accessId.

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

WorkbasketAccessItemController

public WorkbasketAccessItemController()

Method Detail

getWorkbasketAccessItems

@GetMapping
public org.springframework.http.ResponseEntity<org.springframework.hateoas.PagedResources<WorkbasketAccessItemResource>> getWorkbasketAccessItems(@RequestParam
                                                                                                                                                              org.springframework.util.MultiValueMap<String,String> params)
                                                                                                                                                       throws pro.taskana.exceptions.NotAuthorizedException,
                                                                                                                                                              pro.taskana.exceptions.InvalidArgumentException

This GET method return all workbasketAccessItems that correspond the given data.

Parameters:

params - filter, order and access ids.

Returns:

all WorkbasketAccesItemResource.

Throws:

pro.taskana.exceptions.NotAuthorizedException - if the user is not authorized.

pro.taskana.exceptions.InvalidArgumentException - if some argument is invalid.

removeWorkbasketAccessItems

@DeleteMapping
public org.springframework.http.ResponseEntity<Void> removeWorkbasketAccessItems(@RequestParam(value="access-id")
                                                                                                String accessId)
                                                                                         throws pro.taskana.exceptions.NotAuthorizedException,
                                                                                                pro.taskana.exceptions.InvalidArgumentException

This DELETE method delete all workbasketAccessItems that correspond the given accessId.

Parameters:

accessId - which need remove his workbasketAccessItems.

Returns:

ResponseEntity if the user is not authorized.

Throws:

pro.taskana.exceptions.NotAuthorizedException - if the user is not authorized.

pro.taskana.exceptions.InvalidArgumentException - if some argument is invalid.