pro.taskana

Interface WorkbasketService

All Known Implementing Classes:

WorkbasketServiceImpl

public interface WorkbasketService

This service manages Workbaskets.

Method Summary

Modifier and Type	Method and Description
void	checkAuthorization(String workbasketKey, 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 and persist a new Workbasket Authorization with a Workbasket and a AccessId.
WorkbasketQuery	createWorkbasketQuery() This method provides a query builder for querying 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 WorkbasketAccessItem with an id.
List<WorkbasketAccessItem>	getWorkbasketAuthorizations(String workbasketKey) Get all authorizations for a Workbasket.
Workbasket	getWorkbasketByKey(String workbasketKey) Get Workbasket for a given key.
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	newWorkbasket() Returns a new workbasket which is not persisted.
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,
                         InvalidWorkbasketException

Get Workbasket for a given id.

Parameters:

workbasketId - the Id of the Workbasket requested

Returns:

the requested Workbasket

Throws:

WorkbasketNotFoundException - If the Workbasket with workbasketId is not found

InvalidWorkbasketException - If required properties are missing in the found Workbasket

getWorkbasketByKey

Workbasket getWorkbasketByKey(String workbasketKey)
                       throws WorkbasketNotFoundException,
                              InvalidWorkbasketException

Get Workbasket for a given key.

Parameters:

workbasketKey - the Key of the Workbasket requested

Returns:

the requested Workbasket

Throws:

WorkbasketNotFoundException - If the Workbasket with workbasketId is not found

InvalidWorkbasketException - If required properties are missing in the found Workbasket

getWorkbaskets

List<Workbasket> getWorkbaskets()

Get all available Workbaskets.

Returns:

a list containing all Workbaskets

createWorkbasket

Workbasket createWorkbasket(Workbasket workbasket)
                     throws InvalidWorkbasketException,
                            WorkbasketNotFoundException

Create a new Workbasket.

Parameters:

workbasket - The Workbasket to create

Returns:

the created and persisted Workbasket

Throws:

InvalidWorkbasketException - If a required property of the Workbasket is not set.

WorkbasketNotFoundException - If the to be created work basket references a distribution target that does not exist

updateWorkbasket

Workbasket updateWorkbasket(Workbasket workbasket)
                     throws InvalidWorkbasketException,
                            WorkbasketNotFoundException,
                            NotAuthorizedException

Update a Workbasket.

Parameters:

workbasket - The Workbasket to update

Returns:

the updated Workbasket

Throws:

InvalidWorkbasketException - if a required property of the workbasket is not set

WorkbasketNotFoundException - if the updated work basket references a distribution target that does not exist

NotAuthorizedException - if the current user is not authorized to update the work basket

createWorkbasketAuthorization

WorkbasketAccessItem createWorkbasketAuthorization(WorkbasketAccessItem workbasketAccessItem)

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

Parameters:

workbasketAccessItem - the new workbasketAccessItem

Returns:

the created WorkbasketAccessItem

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 id of the WorbasketAccessItem to be deleted

checkAuthorization

void checkAuthorization(String workbasketKey,
                        WorkbasketAuthorization authorization)
                 throws NotAuthorizedException

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

Parameters:

workbasketKey - the key of the workbasket we want to access

authorization - the needed Authorization

Throws:

NotAuthorizedException - if the current user has not the requested authorization fot the specified workbasket

getWorkbasketAuthorization

WorkbasketAccessItem getWorkbasketAuthorization(String id)

This method get one WorkbasketAccessItem with an id.

Parameters:

id - the id of the requested WorkbasketAccessItem

Returns:

the full WorkbasketAccessItem

getWorkbasketAuthorizations

List<WorkbasketAccessItem> getWorkbasketAuthorizations(String workbasketKey)

Get all authorizations for a Workbasket.

Parameters:

workbasketKey - the key of the Workbasket

Returns:

List of WorkbasketAccessItems for the Workbasket with workbasketKey

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 Workbaskets for which the current user has the specified authorizations

createWorkbasketQuery

WorkbasketQuery createWorkbasketQuery()

This method provides a query builder for querying the database.

Returns:

a WorkbasketQuery

newWorkbasket

Workbasket newWorkbasket()

Returns a new workbasket which is not persisted.

Returns:

newWorkbasket