pro.taskana

Interface WorkbasketService

All Known Implementing Classes:

WorkbasketServiceImpl

public interface WorkbasketService

This service manages the Workbaskets.

Method Summary

Modifier and Type	Method and Description
void	checkAuthorization(String workbasketId, WorkbasketAuthorization authorization) This method checks the authorization with the saved one for the actual User.
Workbasket	createWorkbasket(Workbasket workbasket) Create a new Workbasket.
WorkbasketAccessItem	createWorkbasketAuthorization(WorkbasketAccessItem workbasketAccessItem) Create a new Workbasket Authorization with a Workbasket and a AccessId.
WorkbasketQuery	createWorkbasketQuery() This method provides a query builder for quering the database.
void	deleteWorkbasketAuthorization(String id) Deletes a specific authorization.
List<WorkbasketAccessItem>	getAllAuthorizations() Get all authorizations of the workbasket.
Workbasket	getWorkbasket(String workbasketId) Get Workbasket for a given id.
WorkbasketAccessItem	getWorkbasketAuthorization(String id) This method get one WorkbasketAuthorization with an id.
List<WorkbasketAccessItem>	getWorkbasketAuthorizations(String workbasketId) Get all authorizations for a Workbasket.
List<Workbasket>	getWorkbaskets() Get all available Workbaskets.
List<Workbasket>	getWorkbaskets(List<WorkbasketAuthorization> permission) This method returns the workbaskets for which the current user has all permissions specified in the permissions list.
Workbasket	updateWorkbasket(Workbasket workbasket) Update a Workbasket.
WorkbasketAccessItem	updateWorkbasketAuthorization(WorkbasketAccessItem workbasketAccessItem) This method updates an Workbasket Authorization.

Method Detail

getWorkbasket

Workbasket getWorkbasket(String workbasketId)
                  throws WorkbasketNotFoundException

Get Workbasket for a given id.

Parameters:

workbasketId - TODO

Returns:

the requested Workbasket

Throws:

WorkbasketNotFoundException - TODO

getWorkbaskets

List<Workbasket> getWorkbaskets()

Get all available Workbaskets.

Returns:

a list containing all workbaskets

createWorkbasket

Workbasket createWorkbasket(Workbasket workbasket)

Create a new Workbasket.

Parameters:

workbasket - The workbasket to create

Returns:

TODO

updateWorkbasket

Workbasket updateWorkbasket(Workbasket workbasket)
                     throws NotAuthorizedException

Update a Workbasket.

Parameters:

workbasket - The workbasket to update

Returns:

TODO

Throws:

NotAuthorizedException - TODO

createWorkbasketAuthorization

WorkbasketAccessItem createWorkbasketAuthorization(WorkbasketAccessItem workbasketAccessItem)

Create a new Workbasket Authorization with a Workbasket and a AccessId.

Parameters:

workbasketAccessItem - the new workbasketAccessItem

Returns:

TODO

updateWorkbasketAuthorization

WorkbasketAccessItem updateWorkbasketAuthorization(WorkbasketAccessItem workbasketAccessItem)

This method updates an Workbasket Authorization.

Parameters:

workbasketAccessItem - the Authorization

Returns:

the updated entity

getAllAuthorizations

List<WorkbasketAccessItem> getAllAuthorizations()

Get all authorizations of the workbasket.

Returns:

a WorkbasketAccessItem list

deleteWorkbasketAuthorization

void deleteWorkbasketAuthorization(String id)

Deletes a specific authorization.

Parameters:

id - the specific id

checkAuthorization

void checkAuthorization(String workbasketId,
                        WorkbasketAuthorization authorization)
                 throws NotAuthorizedException

This method checks the authorization with the saved one for the actual User.

Parameters:

workbasketId - the workbasket we want to access

authorization - the needed Authorization

Throws:

NotAuthorizedException - TODO

getWorkbasketAuthorization

WorkbasketAccessItem getWorkbasketAuthorization(String id)

This method get one WorkbasketAuthorization with an id.

Parameters:

id - the id

Returns:

the full WorkbasketAccessItem

getWorkbasketAuthorizations

List<WorkbasketAccessItem> getWorkbasketAuthorizations(String workbasketId)

Get all authorizations for a Workbasket.

Parameters:

workbasketId - TODO

Returns:

List of WorkbasketAccessItems

getWorkbaskets

List<Workbasket> getWorkbaskets(List<WorkbasketAuthorization> permission)

This method returns the workbaskets for which the current user has all permissions specified in the permissions list.

Parameters:

permission - a List of WorkbasketAuthorization enums

Returns:

all filtered workbaskets

createWorkbasketQuery

WorkbasketQuery createWorkbasketQuery()

This method provides a query builder for quering the database.

Returns:

a WorkbasketQuery