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	addDistributionTarget(String sourceWorkbasketId, String targetWorkbasketId) Add a distribution target to a workbasket.
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	deleteWorkbasket(String workbasketId) Deletes the workbasket by the given ID of it.
void	deleteWorkbasketAuthorization(String id) Deletes a specific authorization.
List<WorkbasketSummary>	getDistributionTargets(String workbasketId) Returns the distribution targets for a given workbasket.
List<WorkbasketAuthorization>	getPermissionsForWorkbasket(String workbasketKey) Returns a set with all permissions of the current user at this workbasket.
Workbasket	getWorkbasket(String workbasketId) Get Workbasket for a given id.
List<WorkbasketAccessItem>	getWorkbasketAuthorizations(String workbasketKey) Get all authorizations for a Workbasket.
Workbasket	getWorkbasketByKey(String workbasketKey) Get Workbasket for a given key.
List<WorkbasketSummary>	getWorkbaskets() Get all available Workbaskets without checking any permission.
List<WorkbasketSummary>	getWorkbaskets(List<WorkbasketAuthorization> permissions) This method returns the workbaskets for which the current user has all permissions specified in the permissions list.
Workbasket	newWorkbasket(String key) Returns a new workbasket which is not persisted.
WorkbasketAccessItem	newWorkbasketAccessItem(String workbasketKey, String accessId) Returns a new WorkbasketAccessItem which is not persisted.
void	removeDistributionTarget(String sourceWorkbasketId, String targetWorkbasketId) Remove a distribution target from a workbasket.
void	setDistributionTargets(String sourceWorkbasketId, List<String> targetWorkbasketIds) Set the distribution targets for a workbasket.
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,
                                NotAuthorizedException

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

NotAuthorizedException - If the current user or group does not have the permissions for interactions.

getWorkbasketByKey

public Workbasket getWorkbasketByKey(String workbasketKey)
                              throws WorkbasketNotFoundException,
                                     NotAuthorizedException

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

NotAuthorizedException - If the current user or group does not have the permissions for interactions.

getWorkbaskets

public List<WorkbasketSummary> 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:

the summaries of all Workbaskets for which the current user has the specified authorizations

getWorkbaskets

public List<WorkbasketSummary> getWorkbaskets()

Description copied from interface: WorkbasketService

Get all available Workbaskets without checking any permission.

Specified by:

getWorkbaskets in interface WorkbasketService

Returns:

a list containing all Workbasket Summaries

createWorkbasket

public Workbasket createWorkbasket(Workbasket newWorkbasket)
                            throws InvalidWorkbasketException

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.

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

newWorkbasketAccessItem

public WorkbasketAccessItem newWorkbasketAccessItem(String workbasketKey,
                                                    String accessId)

Description copied from interface: WorkbasketService

Returns a new WorkbasketAccessItem which is not persisted.

Specified by:

newWorkbasketAccessItem in interface WorkbasketService

Parameters:

workbasketKey - the workbasket key used to identify the referenced workbasket

accessId - the group id or user id for which access is controlled

Returns:

new WorkbasketAccessItem

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

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

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 for the specified workbasket

updateWorkbasketAuthorization

public WorkbasketAccessItem updateWorkbasketAuthorization(WorkbasketAccessItem workbasketAccessItem)
                                                   throws InvalidArgumentException

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

Throws:

InvalidArgumentException - if accessid or workbasketkey is changed in the workbasketAccessItem

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

getPermissionsForWorkbasket

public List<WorkbasketAuthorization> getPermissionsForWorkbasket(String workbasketKey)

Description copied from interface: WorkbasketService

Returns a set with all permissions of the current user at this workbasket.

Specified by:

getPermissionsForWorkbasket in interface WorkbasketService

Parameters:

workbasketKey - the key of the referenced workbasket

Returns:

a Set with all permissions

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(String key)

Description copied from interface: WorkbasketService

Returns a new workbasket which is not persisted.

Specified by:

newWorkbasket in interface WorkbasketService

Parameters:

key - the workbasket key used to identify the workbasket

Returns:

new Workbasket

getDistributionTargets

public List<WorkbasketSummary> getDistributionTargets(String workbasketId)
                                               throws NotAuthorizedException,
                                                      WorkbasketNotFoundException

Description copied from interface: WorkbasketService

Returns the distribution targets for a given workbasket.

Specified by:

getDistributionTargets in interface WorkbasketService

Parameters:

workbasketId - the id of the referenced workbasket

Returns:

the distribution targets of the specified workbasket

Throws:

NotAuthorizedException - if the current user has no read permission for the specified workbasket

WorkbasketNotFoundException - if the workbasket doesn't exist

setDistributionTargets

public void setDistributionTargets(String sourceWorkbasketId,
                                   List<String> targetWorkbasketIds)
                            throws WorkbasketNotFoundException,
                                   NotAuthorizedException

Description copied from interface: WorkbasketService

Set the distribution targets for a workbasket.

Specified by:

setDistributionTargets in interface WorkbasketService

Parameters:

sourceWorkbasketId - the id of the source workbasket for which the distribution targets are to be set

targetWorkbasketIds - a list of the ids of the target workbaskets

Throws:

WorkbasketNotFoundException - if either the source workbasket or any of the target workbaskets don't exist

NotAuthorizedException - if the current used doesn't have READ permission for the source workbasket

addDistributionTarget

public void addDistributionTarget(String sourceWorkbasketId,
                                  String targetWorkbasketId)
                           throws NotAuthorizedException,
                                  WorkbasketNotFoundException

Description copied from interface: WorkbasketService

Add a distribution target to a workbasket. If the specified distribution target exists already, the method silently returns without doing anything.

Specified by:

addDistributionTarget in interface WorkbasketService

Parameters:

sourceWorkbasketId - the id of the source workbasket

targetWorkbasketId - the id of the target workbasket

Throws:

NotAuthorizedException - if the current user doesn't have READ permission for the source workbasket

WorkbasketNotFoundException - if either the source workbasket or the target workbasket doesn't exist

removeDistributionTarget

public void removeDistributionTarget(String sourceWorkbasketId,
                                     String targetWorkbasketId)
                              throws NotAuthorizedException

Description copied from interface: WorkbasketService

Remove a distribution target from a workbasket. If the the specified distribution target doesn't exist, the method silently returns without doing anything.

Specified by:

removeDistributionTarget in interface WorkbasketService

Parameters:

sourceWorkbasketId - The id of the source workbasket

targetWorkbasketId - The id of the target workbasket

Throws:

NotAuthorizedException - If the current user doesn't have READ permission for the source workbasket

deleteWorkbasket

public void deleteWorkbasket(String workbasketId)
                      throws NotAuthorizedException,
                             WorkbasketNotFoundException,
                             WorkbasketInUseException,
                             InvalidArgumentException

Description copied from interface: WorkbasketService

Deletes the workbasket by the given ID of it.

Specified by:

deleteWorkbasket in interface WorkbasketService

Parameters:

workbasketId - Id of the workbasket which should be deleted.

Throws:

NotAuthorizedException - if the current user got no permissions for this interaction.

WorkbasketNotFoundException - if the workbasket does not exist.

WorkbasketInUseException - if the workbasket does contain task-content.

InvalidArgumentException - if the workbasketId is NULL or EMPTY