Package org.ametys.plugins.workspaces.forum

Class WorkspaceThreadDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.workspaces.AbstractWorkspaceDAO

org.ametys.plugins.workspaces.forum.AbstractWorkspaceThreadDAO

org.ametys.plugins.workspaces.forum.WorkspaceThreadDAO

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class WorkspaceThreadDAO
extends AbstractWorkspaceThreadDAO

DAO for manipulating thread of a project

Field Summary

Fields

Modifier and Type	Field	Description
protected ProjectTagProviderExtensionPoint	_tagProviderExtPt	The tag provider extension point
protected UserPreferencesManager	_userPrefsManager	The user preferences
static final String	RIGHTS_CONTRIBUTE_THREAD	Rights to contribute to threads
static final String	RIGHTS_CREATE_THREAD	Rights to create thread and edit his own thread
static final String	RIGHTS_DELETE_OWN_THREAD	Rights to delete his own thread
static final String	RIGHTS_DELETE_OWN_THREAD_ANSWERS	Rights to delete answers in his own thread
static final String	RIGHTS_HANDLE_ALL_THREAD	Rights to handle all threads
static final String	RIGHTS_REPORT_NOTIFICATION	Rights to handle reports
static final String	RIGHTS_REPORT_NOTIFICATION_OWN_THREAD	Rights to handle reports in his own thread
static final String	ROLE	Avalon Role

Fields inherited from class org.ametys.plugins.workspaces.forum.AbstractWorkspaceThreadDAO

_threadJSONHelper, _workspaceThreadUserPrefDAO

Fields inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceDAO

_context, _currentUserProvider, _observationManager, _projectManager, _projectTagsDAO, _resolver, _richTextTransformer, _rightManager, _userManager, _workflowHelper, _workflowProvider, _workspaceHelper, _workspaceModuleEP

Constructor Summary

Constructors

Constructor	Description
WorkspaceThreadDAO()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	addThread(Map<String,Object> parameters, String search, String category, String tag, Boolean closed, List<Part> newFiles, List<String> newFileNames, Boolean accepted, Boolean hasNotification)	Add a new thread to the threads list
Map<String,Object>	deleteThread(String id)	Delete a thread
Map<String,Object>	editThread(Map<String,Object> parameters, String search, String category, String tag, Boolean closed, List<Part> newFiles, List<String> newFileNames, List<String> deleteFiles, Boolean accepted, Boolean hasNotification)	Edit a thread
Integer	getCategoryThreadCount(String category)	Get the list of threads of a project
List<Thread>	getProjectThreads(Project project, boolean sortByCreationDate)	Get all thread's threads from given projets
Map<String,Object>	getThread(String id)	Get the threads from project
List<String>	getThreadIds(String search, String category, String tag, Boolean closed, Boolean accepted, Boolean hasNotification)	Get the threads of current project
List<Map<String,Object>>	getThreadsByIds(List<String> threadIds)	Get the threads of current project
Long	getThreadsCount(Project project)	Get the total number of threads of the project
Set<Map<String,Object>>	getUsedTags()	Get tags used in any threads
Map<String,Object>	getUserRights()	Get user rights from project name
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.workspaces.forum.AbstractWorkspaceThreadDAO

_checkUserRights, _getModuleRoot, _getModuleRoot, _getThreadByID, _getThreadRoot

Methods inherited from class org.ametys.plugins.workspaces.AbstractWorkspaceDAO

_checkUserReadingRights, _checkUserRights, _getProject, _getProjectName, _getSitemapLanguage, _getSiteName, _handleTags, _hasAfterSubComments, _setAttachments, answerComment, contextualize, createComment, deleteComment, editComment, likeOrUnlikeComment

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

Avalon Role

RIGHTS_HANDLE_ALL_THREAD

public static final String RIGHTS_HANDLE_ALL_THREAD

Rights to handle all threads

See Also:

• Constant Field Values

RIGHTS_REPORT_NOTIFICATION

public static final String RIGHTS_REPORT_NOTIFICATION

Rights to handle reports

See Also:

• Constant Field Values

RIGHTS_CREATE_THREAD

public static final String RIGHTS_CREATE_THREAD

Rights to create thread and edit his own thread

See Also:

• Constant Field Values

RIGHTS_CONTRIBUTE_THREAD

public static final String RIGHTS_CONTRIBUTE_THREAD

Rights to contribute to threads

See Also:

• Constant Field Values

RIGHTS_DELETE_OWN_THREAD

public static final String RIGHTS_DELETE_OWN_THREAD

Rights to delete his own thread

See Also:

• Constant Field Values

RIGHTS_DELETE_OWN_THREAD_ANSWERS

public static final String RIGHTS_DELETE_OWN_THREAD_ANSWERS

Rights to delete answers in his own thread

See Also:

• Constant Field Values

RIGHTS_REPORT_NOTIFICATION_OWN_THREAD

public static final String RIGHTS_REPORT_NOTIFICATION_OWN_THREAD

Rights to handle reports in his own thread

See Also:

• Constant Field Values

_tagProviderExtPt

protected ProjectTagProviderExtensionPoint _tagProviderExtPt

The tag provider extension point

_userPrefsManager

protected UserPreferencesManager _userPrefsManager

The user preferences

Constructor Details

WorkspaceThreadDAO

public WorkspaceThreadDAO()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractWorkspaceThreadDAO

Throws:

ServiceException

addThread

public Map<String,Object> addThread(Map<String,Object> parameters,
 String search,
 String category,
 String tag,
 Boolean closed,
 List<Part> newFiles,
 List<String> newFileNames,
 Boolean accepted,
 Boolean hasNotification)
                             throws IllegalAccessException

Add a new thread to the threads list

Parameters:

parameters - The thread parameters

search - filter by search query

category - filter by categroy id

tag - filter by tag id

closed - filter by closeInfo field

newFiles - the new file to add

newFileNames - the file names to add

accepted - filter by accepted answer

hasNotification - filter by whether subjects have notification

Returns:

The thread data

Throws:

IllegalAccessException - If an error occurs when checking the rights

editThread

public Map<String,Object> editThread(Map<String,Object> parameters,
 String search,
 String category,
 String tag,
 Boolean closed,
 List<Part> newFiles,
 List<String> newFileNames,
 List<String> deleteFiles,
 Boolean accepted,
 Boolean hasNotification)
                              throws IllegalAccessException

Edit a thread

Parameters:

parameters - The thread parameters

search - filter by search query

category - filter by categroy id

tag - filter by tag id

closed - filter by closeInfo field

newFiles - the new file to add

newFileNames - the file names to add

deleteFiles - the file to delete

accepted - filter by accepted answer

hasNotification - filter by whether subjects have notification

Returns:

The thread data

Throws:

IllegalAccessException - If an error occurs when checking the rights

deleteThread

public Map<String,Object> deleteThread(String id)
                                throws IllegalAccessException

Delete a thread

Parameters:

id - The thread id

Returns:

The thread data

Throws:

IllegalAccessException - If an error occurs when checking the rights

getCategoryThreadCount

public Integer getCategoryThreadCount(String category)
                               throws IllegalAccessException

Get the list of threads of a project

Parameters:

category - The category to filter

Returns:

The list of threads

Throws:

IllegalAccessException - If an error occurs when checking the rights

getThreadIds

public List<String> getThreadIds(String search,
 String category,
 String tag,
 Boolean closed,
 Boolean accepted,
 Boolean hasNotification)
                          throws IllegalAccessException

Get the threads of current project

Parameters:

search - filter by search query

category - filter by categroy id

tag - filter by tag id

closed - filter by closeInfo field

accepted - filter by accepted answer

hasNotification - filter by whether subjects have notification

Returns:

the list of threads

Throws:

IllegalAccessException - If an error occurs when checking the rights

getThreadsByIds

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

Get the threads of current project

Parameters:

threadIds - list of threads id

Returns:

the list of threads

Throws:

IllegalAccessException - If an error occurs when checking the rights

getThread

public Map<String,Object> getThread(String id)
                             throws IllegalAccessException

Get the threads from project

Parameters:

id - the id of the page

Returns:

the list of threads

Throws:

IllegalAccessException - If an error occurs when checking the rights

getProjectThreads

public List<Thread> getProjectThreads(Project project,
 boolean sortByCreationDate)

Get all thread's threads from given projets

Parameters:

project - the project

sortByCreationDate - true to sort by creation date

Returns:

All threads as JSON

getThreadsCount

public Long getThreadsCount(Project project)

Get the total number of threads of the project

Parameters:

project - The project

Returns:

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

getUserRights

public Map<String,Object> getUserRights()

Get user rights from project name

Returns:

the user rights

getUsedTags

public Set<Map<String,Object>> getUsedTags()

Get tags used in any threads

Returns:

the tags (id and label)