pro.taskana.impl

Class WorkbasketServiceImpl

java.lang.Object

pro.taskana.impl.WorkbasketServiceImpl

All Implemented Interfaces:

WorkbasketService

public class WorkbasketServiceImpl
extends Object
implements WorkbasketService

This is the implementation of WorkbasketService.

Constructor Summary

Constructors

Constructor and Description
WorkbasketServiceImpl()
WorkbasketServiceImpl(TaskanaEngine taskanaEngine, WorkbasketMapper workbasketMapper, DistributionTargetMapper distributionTargetMapper, WorkbasketAccessMapper workbasketAccessMapper)

Method Summary

Modifier and Type	Method and Description
void	checkAuthorization(String workbasketKey, WorkbasketAuthorization workbasketAuthorization) This method checks the authorization with the saved one for the actual User.
Workbasket	createWorkbasket(Workbasket newWorkbasket) 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> permissions) 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 workbasketToUpdate) Update a Workbasket.
WorkbasketAccessItem	updateWorkbasketAuthorization(WorkbasketAccessItem workbasketAccessItem) This method updates an Workbasket Authorization.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkbasketServiceImpl

public WorkbasketServiceImpl()

WorkbasketServiceImpl

public WorkbasketServiceImpl(TaskanaEngine taskanaEngine,
                             WorkbasketMapper workbasketMapper,
                             DistributionTargetMapper distributionTargetMapper,
                             WorkbasketAccessMapper workbasketAccessMapper)

Method Detail

getWorkbasket

public Workbasket getWorkbasket(String workbasketId)
                         throws WorkbasketNotFoundException,
                                InvalidWorkbasketException

Description copied from interface: WorkbasketService

Get Workbasket for a given id.

Specified by:

getWorkbasket in interface WorkbasketService

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

public Workbasket getWorkbasketByKey(String workbasketKey)
                              throws WorkbasketNotFoundException,
                                     InvalidWorkbasketException

Description copied from interface: WorkbasketService

Get Workbasket for a given key.

Specified by:

getWorkbasketByKey in interface WorkbasketService

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

public List<Workbasket> getWorkbaskets(List<WorkbasketAuthorization> permissions)

Description copied from interface: WorkbasketService

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

Specified by:

getWorkbaskets in interface WorkbasketService

Parameters:

permissions - a List of WorkbasketAuthorization enums

Returns:

all Workbaskets for which the current user has the specified authorizations

getWorkbaskets

public List<Workbasket> getWorkbaskets()

Description copied from interface: WorkbasketService

Get all available Workbaskets.

Specified by:

getWorkbaskets in interface WorkbasketService

Returns:

a list containing all Workbaskets

createWorkbasket

public Workbasket createWorkbasket(Workbasket newWorkbasket)
                            throws InvalidWorkbasketException,
                                   WorkbasketNotFoundException

Description copied from interface: WorkbasketService

Create a new Workbasket.

Specified by:

createWorkbasket in interface WorkbasketService

Parameters:

newWorkbasket - 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

public Workbasket updateWorkbasket(Workbasket workbasketToUpdate)
                            throws NotAuthorizedException,
                                   WorkbasketNotFoundException,
                                   InvalidWorkbasketException

Description copied from interface: WorkbasketService

Update a Workbasket.

Specified by:

updateWorkbasket in interface WorkbasketService

Parameters:

workbasketToUpdate - The Workbasket to update

Returns:

the updated Workbasket

Throws:

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

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

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

createWorkbasketAuthorization

public WorkbasketAccessItem createWorkbasketAuthorization(WorkbasketAccessItem workbasketAccessItem)

Description copied from interface: WorkbasketService

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

Specified by:

createWorkbasketAuthorization in interface WorkbasketService

Parameters:

workbasketAccessItem - the new workbasketAccessItem

Returns:

the created WorkbasketAccessItem

getWorkbasketAuthorization

public WorkbasketAccessItem getWorkbasketAuthorization(String id)

Description copied from interface: WorkbasketService

This method get one WorkbasketAccessItem with an id.

Specified by:

getWorkbasketAuthorization in interface WorkbasketService

Parameters:

id - the id of the requested WorkbasketAccessItem

Returns:

the full WorkbasketAccessItem

deleteWorkbasketAuthorization

public void deleteWorkbasketAuthorization(String id)

Description copied from interface: WorkbasketService

Deletes a specific authorization.

Specified by:

deleteWorkbasketAuthorization in interface WorkbasketService

Parameters:

id - the id of the WorbasketAccessItem to be deleted

getAllAuthorizations

public List<WorkbasketAccessItem> getAllAuthorizations()

Description copied from interface: WorkbasketService

Get all authorizations of the workbasket.

Specified by:

getAllAuthorizations in interface WorkbasketService

Returns:

a WorkbasketAccessItem list

checkAuthorization

public void checkAuthorization(String workbasketKey,
                               WorkbasketAuthorization workbasketAuthorization)
                        throws NotAuthorizedException

Description copied from interface: WorkbasketService

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

Specified by:

checkAuthorization in interface WorkbasketService

Parameters:

workbasketKey - the key of the workbasket we want to access

workbasketAuthorization - the needed Authorization

Throws:

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

updateWorkbasketAuthorization

public WorkbasketAccessItem updateWorkbasketAuthorization(WorkbasketAccessItem workbasketAccessItem)

Description copied from interface: WorkbasketService

This method updates an Workbasket Authorization.

Specified by:

updateWorkbasketAuthorization in interface WorkbasketService

Parameters:

workbasketAccessItem - the Authorization

Returns:

the updated entity

getWorkbasketAuthorizations

public List<WorkbasketAccessItem> getWorkbasketAuthorizations(String workbasketKey)

Description copied from interface: WorkbasketService

Get all authorizations for a Workbasket.

Specified by:

getWorkbasketAuthorizations in interface WorkbasketService

Parameters:

workbasketKey - the key of the Workbasket

Returns:

List of WorkbasketAccessItems for the Workbasket with workbasketKey

createWorkbasketQuery

public WorkbasketQuery createWorkbasketQuery()

Description copied from interface: WorkbasketService

This method provides a query builder for querying the database.

Specified by:

createWorkbasketQuery in interface WorkbasketService

Returns:

a WorkbasketQuery

newWorkbasket

public Workbasket newWorkbasket()

Description copied from interface: WorkbasketService

Returns a new workbasket which is not persisted.

Specified by:

newWorkbasket in interface WorkbasketService

Returns:

newWorkbasket