Package org.ametys.plugins.workspaces.tasks

Class WorkspaceTasksListDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.tasks.AbstractWorkspaceTaskDAO

org.ametys.plugins.workspaces.tasks.WorkspaceTasksListDAO

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class WorkspaceTasksListDAO
extends AbstractWorkspaceTaskDAO

DAO for interacting with tasks list of a project

Field Summary

Fields

Modifier and Type	Field	Description
protected static AmetysObjectResolver	_resolver	The ametys object resolver
protected TasksListColorsComponent	_tasksListColorsComponent	The tasks list colors component
protected TasksListIconsComponent	_tasksListIconsComponent	The tasks list icons component
protected TasksListJSONHelper	_tasksListJSONHelper	The tasks list JSON helper
static final String	ROLE	The Avalon role

Fields inherited from class org.ametys.plugins.workspaces.tasks.AbstractWorkspaceTaskDAO

_context, _currentUserProvider, _moduleEP, _observationManager, _projectManager, _rightManager, RIGHTS_COMMENT_TASK, RIGHTS_DELETE_COMMENT_TASK, RIGHTS_DELETE_TASK, RIGHTS_DELETE_TASK_LIST, RIGHTS_HANDLE_TASK, RIGHTS_HANDLE_TASK_LIST

Constructor Summary

Constructors

Constructor	Description
WorkspaceTasksListDAO()

Method Summary

Modifier and Type	Method	Description
protected void	_checkTasksList(AmetysObject objectToCheck)	Check the ametys object is a tasks list
protected void	_checkUserRights(AmetysObject objectToCheck, String rightId)	Check user rights
protected List<TasksList>	_getProjectsTasksLists(String projectName)	Get the list of tasks lists from given project name
protected List<TasksList>	_getProjectTasksLists(Project project)	Get the project tasks lists
Map<String,Object>	addTasksList(String label)	Add a new tasks list to the project
Map<String,Object>	deleteTasksList(String tasksListId)	Delete a tasks list
Map<String,Object>	editTasksList(String tasksListId, String newLabel)	Edit a tasks list
static List<Task>	getChildTask(String tasksListId)	Get the child task of the tasks list
List<Map<String,String>>	getTasksListColors()	Get all available colors for the tasks list
List<Map<String,String>>	getTasksListIcons()	Get all available icons for the tasks list
List<Map<String,Object>>	getTasksLists()	Get the tasks lists from the project
Map<String,Object>	moveTasksList(String tasksListId, long newPosition)	Move tasks list to new position
void	service(ServiceManager manager)
Map<String,Object>	updateTasksListColor(String tasksListId, String colorId)	Update the tasks list color
Map<String,Object>	updateTasksListIcon(String tasksListId, String iconId)	Update the tasks list icon

Methods inherited from class org.ametys.plugins.workspaces.tasks.AbstractWorkspaceTaskDAO

_getModuleRoot, _getProjectName, _getSitemapLanguage, _getSiteName, _getTasksListsRoot, _getTasksRoot, contextualize, getUserRights

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

The Avalon role

_resolver

protected static AmetysObjectResolver _resolver

The ametys object resolver

_tasksListJSONHelper

protected TasksListJSONHelper _tasksListJSONHelper

The tasks list JSON helper

_tasksListColorsComponent

protected TasksListColorsComponent _tasksListColorsComponent

The tasks list colors component

_tasksListIconsComponent

protected TasksListIconsComponent _tasksListIconsComponent

The tasks list icons component

Constructor Details

WorkspaceTasksListDAO

public WorkspaceTasksListDAO()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractWorkspaceTaskDAO

Throws:

ServiceException

getTasksLists

public List<Map<String,Object>> getTasksLists()
                                       throws IllegalAccessException

Get the tasks lists from the project

Returns:

the tasks lists

Throws:

IllegalAccessException - If an error occurs when checking the rights

addTasksList

public Map<String,Object> addTasksList(String label)
                                throws IllegalAccessException

Add a new tasks list to the project

Parameters:

label - the tasks list label

Returns:

The tasks list data

Throws:

IllegalAccessException - If an error occurs when checking the rights

editTasksList

public Map<String,Object> editTasksList(String tasksListId,
 String newLabel)
                                 throws IllegalAccessException

Edit a tasks list

Parameters:

tasksListId - The id of the tasks list to edit

newLabel - The tasks list new label

Returns:

The tasks list data

Throws:

IllegalAccessException - If an error occurs when checking the rights

deleteTasksList

public Map<String,Object> deleteTasksList(String tasksListId)
                                   throws IllegalAccessException

Delete a tasks list

Parameters:

tasksListId - the tasks list id to remove

Returns:

the tasks list data

Throws:

IllegalAccessException - If an error occurs when checking the rights

moveTasksList

public Map<String,Object> moveTasksList(String tasksListId,
 long newPosition)
                                 throws IllegalAccessException

Move tasks list to new position

Parameters:

tasksListId - the tasks list id to move

newPosition - the new position

Returns:

The tasks list data

Throws:

IllegalAccessException - If an error occurs when checking the rights

getTasksListColors

public List<Map<String,String>> getTasksListColors()

Get all available colors for the tasks list

Returns:

the colors

getTasksListIcons

public List<Map<String,String>> getTasksListIcons()

Get all available icons for the tasks list

Returns:

the icons

updateTasksListColor

public Map<String,Object> updateTasksListColor(String tasksListId,
 String colorId)
                                        throws IllegalAccessException

Update the tasks list color

Parameters:

tasksListId - the tasks list id

colorId - the color id

Returns:

The tasks list data

Throws:

IllegalAccessException - If an error occurs when checking the rights

updateTasksListIcon

public Map<String,Object> updateTasksListIcon(String tasksListId,
 String iconId)
                                       throws IllegalAccessException

Update the tasks list icon

Parameters:

tasksListId - the tasks list id

iconId - the icon id

Returns:

The tasks list data

Throws:

IllegalAccessException - If an error occurs when checking the rights

_checkTasksList

protected void _checkTasksList(AmetysObject objectToCheck)

Check the ametys object is a tasks list

Parameters:

objectToCheck - the object to check

_checkUserRights

protected void _checkUserRights(AmetysObject objectToCheck,
 String rightId)
                         throws IllegalAccessException

Check user rights

Parameters:

objectToCheck - the object to check

rightId - the right id

Throws:

IllegalAccessException - if a right error occurred

_getProjectsTasksLists

protected List<TasksList> _getProjectsTasksLists(String projectName)

Get the list of tasks lists from given project name

Parameters:

projectName - The project name.

Returns:

the list of tasks lists

_getProjectTasksLists

protected List<TasksList> _getProjectTasksLists(Project project)

Get the project tasks lists

Parameters:

project - the project

Returns:

the list of tasks lists

getChildTask

public static List<Task> getChildTask(String tasksListId)

Get the child task of the tasks list

Parameters:

tasksListId - the tasks list id

Returns:

the list of task