Package org.ametys.plugins.workspaces.tasks

Class WorkspaceTaskDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.tasks.AbstractWorkspaceTaskDAO

org.ametys.plugins.workspaces.tasks.WorkspaceTaskDAO

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class WorkspaceTaskDAO
extends AbstractWorkspaceTaskDAO

DAO for interacting with tasks of a project

Field Summary

Fields

Modifier and Type	Field	Description
protected HTMLTransformer	_htmlTransformer	The HTML transformer
protected ProjectMemberManager	_projectMemberManager	The project member manager
protected ProjectTagsDAO	_projectTagsDAO	The project tags DAO
protected AmetysObjectResolver	_resolver	The ametys object resolver
protected ProjectTagProviderExtensionPoint	_tagProviderExtPt	The tag provider extension point
protected TaskJSONHelper	_taskJSONHelper	The task JSON helper
protected UserManager	_userManager	The user manager
static 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
WorkspaceTaskDAO()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	_setTaskAttributes(JCRTask task, Map<String,Object> parameters, List<Part> newFiles, List<String> newFileNames, List<String> deleteFiles)	Set task's attributes
Map<String,Object>	addTask(String tasksListId, Map<String,Object> parameters, List<Part> newFiles, List<String> newFileNames)	Add a new task to the tasks list
Map<String,Object>	answerCommentTask(String taskId, String commentId, String commentText, String authorURL)	Answer to a task's comment
Map<String,Object>	commentTask(String taskId, String commentText, String authorURL)	Comment a task
Map<String,Object>	deleteCommentTask(String taskId, String commentId)	Delete a task's comment
Map<String,Object>	deleteTask(String taskId)	Remove a task
Map<String,Object>	editCommentTask(String taskId, String commentId, String commentText)	Edit a task
Map<String,Object>	editTask(String taskId, Map<String,Object> parameters, List<Part> newFiles, List<String> newFileNames, List<String> deleteFiles)	Edit a task
Map<String,Object>	getProjectMembers()	Get project members
List<Task>	getProjectTasks(Project project)	Get all tasks from given projets
List<Map<String,Object>>	getTasks()	Get the tasks from project
Long	getTasksCount(Project project)	Get the total number of tasks of the project
Map<String,Object>	likeOrUnlikeCommentTask(String taskId, String commentId, Boolean liked)	Like or unlike a task's comment
Map<String,Object>	moveTask(String tasksListId, String taskId, long newPosition)	Move task to new position
void	service(ServiceManager manager)

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 Detail

ROLE

public static final String ROLE

The Avalon role

_resolver

protected AmetysObjectResolver _resolver

The ametys object resolver

_htmlTransformer

protected HTMLTransformer _htmlTransformer

The HTML transformer

_projectMemberManager

protected ProjectMemberManager _projectMemberManager

The project member manager

_tagProviderExtPt

protected ProjectTagProviderExtensionPoint _tagProviderExtPt

The tag provider extension point

_projectTagsDAO

protected ProjectTagsDAO _projectTagsDAO

The project tags DAO

_userManager

protected UserManager _userManager

The user manager

_taskJSONHelper

protected TaskJSONHelper _taskJSONHelper

The task JSON helper

Constructor Detail

WorkspaceTaskDAO

public WorkspaceTaskDAO()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractWorkspaceTaskDAO

Throws:

ServiceException

getTasks

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

Get the tasks from project

Returns:

the list of tasks

Throws:

IllegalAccessException - If an error occurs when checking the rights

addTask

public Map<String,Object> addTask(String tasksListId,
                                        Map<String,Object> parameters,
                                        List<Part> newFiles,
                                        List<String> newFileNames)
                                 throws IllegalAccessException

Add a new task to the tasks list

Parameters:

tasksListId - the tasks list id

parameters - The task parameters

newFiles - the files to add

newFileNames - the file names to add

Returns:

The task data

Throws:

IllegalAccessException - If an error occurs when checking the rights

editTask

public Map<String,Object> editTask(String taskId,
                                         Map<String,Object> parameters,
                                         List<Part> newFiles,
                                         List<String> newFileNames,
                                         List<String> deleteFiles)
                                  throws IllegalAccessException

Edit a task

Parameters:

taskId - The id of the task to edit

parameters - The JS parameters

newFiles - the new file to add

newFileNames - the file names to add

deleteFiles - the file to delete

Returns:

The task data

Throws:

IllegalAccessException - If an error occurs when checking the rights

moveTask

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

Move task to new position

Parameters:

tasksListId - the tasks list id

taskId - the task id to move

newPosition - the new position

Returns:

The task data

Throws:

IllegalAccessException - If an error occurs when checking the rights

deleteTask

public Map<String,Object> deleteTask(String taskId)
                                    throws IllegalAccessException

Remove a task

Parameters:

taskId - the task id to remove

Returns:

The task data

Throws:

IllegalAccessException - If an error occurs when checking the rights

commentTask

public Map<String,Object> commentTask(String taskId,
                                            String commentText,
                                            String authorURL)
                                     throws IllegalAccessException

Comment a task

Parameters:

taskId - the task id

commentText - the comment text

authorURL - the author URL

Returns:

The task data

Throws:

IllegalAccessException - If an error occurs when checking the rights

editCommentTask

public Map<String,Object> editCommentTask(String taskId,
                                                String commentId,
                                                String commentText)
                                         throws IllegalAccessException

Edit a task

Parameters:

taskId - the task id

commentId - the comment Id

commentText - the comment text

Returns:

The task data

Throws:

IllegalAccessException - If an error occurs when checking the rights

answerCommentTask

public Map<String,Object> answerCommentTask(String taskId,
                                                  String commentId,
                                                  String commentText,
                                                  String authorURL)
                                           throws IllegalAccessException

Answer to a task's comment

Parameters:

taskId - the task id

commentId - the comment id

commentText - the comment text

authorURL - the author URL

Returns:

The task data

Throws:

IllegalAccessException - If an error occurs when checking the rights

deleteCommentTask

public Map<String,Object> deleteCommentTask(String taskId,
                                                  String commentId)
                                           throws IllegalAccessException

Delete a task's comment

Parameters:

taskId - the task id

commentId - the comment id

Returns:

The task data

Throws:

IllegalAccessException - If an error occurs when checking the rights

likeOrUnlikeCommentTask

public Map<String,Object> likeOrUnlikeCommentTask(String taskId,
                                                        String commentId,
                                                        Boolean liked)
                                                 throws IllegalAccessException

Like or unlike a task's comment

Parameters:

taskId - the task id

commentId - the comment id

liked - true if the comment is liked, otherwise the comment is unliked

Returns:

The task data

Throws:

IllegalAccessException - If an error occurs when checking the rights

_setTaskAttributes

protected Map<String,Object> _setTaskAttributes(JCRTask task,
                                                      Map<String,Object> parameters,
                                                      List<Part> newFiles,
                                                      List<String> newFileNames,
                                                      List<String> deleteFiles)

Set task's attributes

Parameters:

task - The task to edit

parameters - The JS parameters

newFiles - the new file to add to the task

newFileNames - the new file names to add to the task

deleteFiles - the file to remove from the task

Returns:

the map of results

getProjectTasks

public List<Task> getProjectTasks(Project project)

Get all tasks from given projets

Parameters:

project - the project

Returns:

All tasks as JSON

getTasksCount

public Long getTasksCount(Project project)

Get the total number of tasks of the project

Parameters:

project - The project

Returns:

The number of tasks, or null if the module is not activated

getProjectMembers

public Map<String,Object> getProjectMembers()
                                           throws IllegalAccessException,
                                                  AmetysRepositoryException

Get project members

Returns:

the project members

Throws:

IllegalAccessException - if an error occurred

AmetysRepositoryException - if an error occurred