Package org.ametys.plugins.workspaces.forum

Class WorkspaceThreadCommentDAO

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.WorkspaceThreadCommentDAO

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class WorkspaceThreadCommentDAO
extends AbstractWorkspaceThreadDAO

DAO for manipulating thread comments

Field Summary

Fields

Modifier and Type	Field	Description
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
WorkspaceThreadCommentDAO()

Method Summary

Modifier and Type	Method	Description
protected RichTextComment	_setAcceptedComment(CommentableAmetysObject<RichTextComment> commentableAmetysObject, String commentId, ModifiableTraversableAmetysObject moduleRoot, boolean isAccepted)	Cancel a comment set as accepted answer
Map<String,Object>	acceptComment(String threadId, String commentId, String oldCommentId, Boolean accepted)	Accept a thread's comment
Map<String,Object>	answerComment(String threadId, String commentId, String commentText)	Answer to a thread comment
Map<String,Object>	cancelAcceptComment(String threadId, String commentId, Boolean accepted)	Cancel a comment set as accepted answer
Map<String,Object>	clearReports(String threadId, String commentId)	Clear reports of a thread's comment
Map<String,Object>	createComment(String threadId, String commentText)	Comment a thread
Map<String,Object>	deleteComment(String threadId, String commentId, Boolean accepted)	Delete a thread comment
Map<String,Object>	editComment(String threadId, String commentId, String commentText)	Edit a thread comment
Map<String,Object>	likeOrUnlikeComment(String threadId, String commentId, Boolean liked)	Like or unlike a thread's comment
Map<String,Object>	reportComment(String threadId, String commentId)	Report a thread's comment

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

_checkUserRights, _getModuleRoot, _getModuleRoot, _getThreadByID, _getThreadRoot, service

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

Constructor Details

WorkspaceThreadCommentDAO

public WorkspaceThreadCommentDAO()

Method Details

createComment

public Map<String,Object> createComment(String threadId,
 String commentText)
                                 throws IllegalAccessException

Comment a thread

Parameters:

threadId - the thread id

commentText - the comment text

Returns:

The thread data

Throws:

IllegalAccessException - If an error occurs when checking the rights

editComment

public Map<String,Object> editComment(String threadId,
 String commentId,
 String commentText)
                               throws IllegalAccessException

Edit a thread comment

Parameters:

threadId - the thread id

commentId - the comment Id

commentText - the comment text

Returns:

The thread data

Throws:

IllegalAccessException - If an error occurs when checking the rights

deleteComment

public Map<String,Object> deleteComment(String threadId,
 String commentId,
 Boolean accepted)
                                 throws IllegalAccessException

Delete a thread comment

Parameters:

threadId - the thread id

commentId - the comment id

accepted - filter by accepted answer

Returns:

The thread data

Throws:

IllegalAccessException - If an error occurs when checking the rights

answerComment

public Map<String,Object> answerComment(String threadId,
 String commentId,
 String commentText)
                                 throws IllegalAccessException

Answer to a thread comment

Parameters:

threadId - the thread id

commentId - the comment id

commentText - the comment text

Returns:

The thread data

Throws:

IllegalAccessException - If an error occurs when checking the rights

likeOrUnlikeComment

public Map<String,Object> likeOrUnlikeComment(String threadId,
 String commentId,
 Boolean liked)
                                       throws IllegalAccessException

Like or unlike a thread's comment

Parameters:

threadId - the thread id

commentId - the comment id

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

Returns:

The thread data

Throws:

IllegalAccessException - If an error occurs when checking the rights

acceptComment

public Map<String,Object> acceptComment(String threadId,
 String commentId,
 String oldCommentId,
 Boolean accepted)
                                 throws IllegalAccessException

Accept a thread's comment

Parameters:

threadId - the thread id

commentId - the comment id to set as new accepted answer

oldCommentId - the comment id of the old accepted answer, to set to false if it exists

accepted - filter by accepted answer

Returns:

The thread data

Throws:

IllegalAccessException - If an error occurs when checking the rights

cancelAcceptComment

public Map<String,Object> cancelAcceptComment(String threadId,
 String commentId,
 Boolean accepted)
                                       throws IllegalAccessException

Cancel a comment set as accepted answer

Parameters:

threadId - the thread id

commentId - the comment id to remove as accepted answer

accepted - filter by accepted answer

Returns:

The thread data

Throws:

IllegalAccessException - If an error occurs when checking the rights

_setAcceptedComment

protected RichTextComment _setAcceptedComment(CommentableAmetysObject<RichTextComment> commentableAmetysObject,
 String commentId,
 ModifiableTraversableAmetysObject moduleRoot,
 boolean isAccepted)

Cancel a comment set as accepted answer

Parameters:

commentableAmetysObject - the commentableAmetysObject

commentId - the comment id to remove as accepted answer

moduleRoot - the module root

isAccepted - true to set the comment as accepted answer.

Returns:

The commentableAmetysObject

reportComment

public Map<String,Object> reportComment(String threadId,
 String commentId)
                                 throws IllegalAccessException

Report a thread's comment

Parameters:

threadId - the thread id

commentId - the comment id of the comment to report

Returns:

The thread data

Throws:

IllegalAccessException - If an error occurs when checking the rights

clearReports

public Map<String,Object> clearReports(String threadId,
 String commentId)
                                throws IllegalAccessException

Clear reports of a thread's comment

Parameters:

threadId - the thread id

commentId - the comment id of the comment to clear

Returns:

The thread data

Throws:

IllegalAccessException - If an error occurs when checking the rights