java.lang.Object
- pro.taskana.common.rest.AbstractPagingController
- - pro.taskana.workbasket.rest.WorkbasketAccessItemController

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

Controller for Workbasket access.

Constructor Summary

Constructors
Constructor	Description
`WorkbasketAccessItemController(LdapClient ldapClient, pro.taskana.workbasket.api.WorkbasketService workbasketService, WorkbasketAccessItemRepresentationModelAssembler modelAssembler)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`org.springframework.http.ResponseEntity<TaskanaPagedModel<WorkbasketAccessItemRepresentationModel>>`	`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.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

Constructor Detail

WorkbasketAccessItemController

@Autowired
public WorkbasketAccessItemController(LdapClient ldapClient,
                                      pro.taskana.workbasket.api.WorkbasketService workbasketService,
                                      WorkbasketAccessItemRepresentationModelAssembler modelAssembler)

Method Detail

getWorkbasketAccessItems

@GetMapping(path="/api/v1/workbasket-access-items")
public org.springframework.http.ResponseEntity<TaskanaPagedModel<WorkbasketAccessItemRepresentationModel>> getWorkbasketAccessItems(@RequestParam
                                                                                                                                    org.springframework.util.MultiValueMap<String,String> params)
                                                                                                                             throws pro.taskana.common.api.exceptions.NotAuthorizedException,
                                                                                                                                    pro.taskana.common.api.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.common.api.exceptions.NotAuthorizedException - if the user is not authorized.; pro.taskana.common.api.exceptions.InvalidArgumentException - if some argument is invalid.

removeWorkbasketAccessItems

@DeleteMapping(path="/api/v1/workbasket-access-items")
public org.springframework.http.ResponseEntity<Void> removeWorkbasketAccessItems(@RequestParam("access-id")
                                                                                 String accessId)
                                                                          throws pro.taskana.common.api.exceptions.NotAuthorizedException,
                                                                                 pro.taskana.common.api.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.common.api.exceptions.NotAuthorizedException - if the user is not authorized.; pro.taskana.common.api.exceptions.InvalidArgumentException - if some argument is invalid.

Class WorkbasketAccessItemController