org.nuxeo.ecm.platform.comment.impl

Class PropertyCommentManager

java.lang.Object

org.nuxeo.ecm.platform.comment.impl.AbstractCommentManager

org.nuxeo.ecm.platform.comment.impl.PropertyCommentManager

All Implemented Interfaces:

CommentManager

public class PropertyCommentManager
extends AbstractCommentManager

Comment service implementation. The comments are linked together thanks to a parent document id property.

Since:

10.3

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.ecm.platform.comment.api.CommentManager

CommentManager.Feature

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COMMENT_NAME
protected static String	GET_COMMENT_PAGEPROVIDER_NAME
protected static String	GET_COMMENTS_FOR_DOC_PAGEPROVIDER_NAME
protected static String	HIDDEN_FOLDER_TYPE

Fields inherited from class org.nuxeo.ecm.platform.comment.impl.AbstractCommentManager

COMMENTS_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
PropertyCommentManager()

Method Summary

Modifier and Type	Method and Description
Comment	createComment(CoreSession session, Comment comment) Creates a comment.
DocumentModel	createComment(DocumentModel docModel, DocumentModel commentModel) Creates a comment document model, filling its properties with given info and linking it to given document.
DocumentModel	createComment(DocumentModel docModel, DocumentModel parent, DocumentModel child) Creates a comment document model, filling its properties with given info and linking it to given document.
DocumentModel	createComment(DocumentModel docModel, String comment) Creates a comment.
DocumentModel	createComment(DocumentModel docModel, String text, String author) Creates a comment document model, filling its properties with given info and linking it to given document.
DocumentModel	createLocatedComment(DocumentModel docModel, DocumentModel comment, String path) Creates a comment document model.
void	deleteComment(CoreSession session, String commentId) Deletes a comment.
void	deleteComment(DocumentModel docModel, DocumentModel comment) Deletes a comment.
void	deleteExternalComment(CoreSession session, String entityId) Deletes an external comment.
protected DocumentRef	getAncestorRef(CoreSession session, DocumentModel documentModel)
Comment	getComment(CoreSession session, String commentId) Gets a comment.
protected String	getCommentContainerPath(CoreSession session, String commentedDocumentId)
List<DocumentModel>	getComments(CoreSession session, DocumentModel docModel) Gets comments of a document.
PartialList<Comment>	getComments(CoreSession session, String documentId, Long pageSize, Long currentPageIndex, boolean sortAscending) Gets all comments for a document.
List<DocumentModel>	getComments(DocumentModel docModel, DocumentModel parent) Get comments of a document.
List<DocumentModel>	getDocumentsForComment(DocumentModel comment) Gets documents in relation with a particular comment.
Comment	getExternalComment(CoreSession session, String entityId) Gets a comment generated by an external service.
protected DocumentModel	getExternalCommentModel(CoreSession session, String entityId)
protected DocumentModel	getThreadForComment(CoreSession session, DocumentModel comment)
DocumentModel	getThreadForComment(DocumentModel comment) Gets thread in relation with a given comment (post or comment).
boolean	hasFeature(CommentManager.Feature feature) Checks if a feature is available.
Comment	updateComment(CoreSession session, String commentId, Comment comment) Updates a comment.
Comment	updateExternalComment(CoreSession session, String entityId, Comment comment) Updates an external comment.

Methods inherited from class org.nuxeo.ecm.platform.comment.impl.AbstractCommentManager

computeAncestorIds, getAuthor, getComments, getComments, getComments, getComments, notifyEvent, setCommentPermissions, setFolderPermissions

Methods inherited from class java.lang.Object

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

Field Detail

GET_COMMENT_PAGEPROVIDER_NAME

protected static final String GET_COMMENT_PAGEPROVIDER_NAME

See Also:

Constant Field Values

GET_COMMENTS_FOR_DOC_PAGEPROVIDER_NAME

protected static final String GET_COMMENTS_FOR_DOC_PAGEPROVIDER_NAME

See Also:

Constant Field Values

HIDDEN_FOLDER_TYPE

protected static final String HIDDEN_FOLDER_TYPE

See Also:

Constant Field Values

COMMENT_NAME

protected static final String COMMENT_NAME

See Also:

Constant Field Values

Constructor Detail

PropertyCommentManager

public PropertyCommentManager()

Method Detail

getComments

public List<DocumentModel> getComments(CoreSession session,
                                       DocumentModel docModel)
                                throws CommentSecurityException

Description copied from interface: CommentManager

Gets comments of a document.

Parameters:

session - the core session

docModel - the document model

Returns:

the list of comments

Throws:

CommentSecurityException - if the current user does not have the right permissions on the commented document

getComments

public List<DocumentModel> getComments(DocumentModel docModel,
                                       DocumentModel parent)

Description copied from interface: CommentManager

Get comments of a document.

Specified by:

getComments in interface CommentManager

Overrides:

getComments in class AbstractCommentManager

Parameters:

docModel - the document model

parent - the parent document model

Returns:

the list of comments

createComment

public DocumentModel createComment(DocumentModel docModel,
                                   String comment)

Description copied from interface: CommentManager

Creates a comment.

Parameters:

docModel - the document to comment

comment - the comment content

createComment

public DocumentModel createComment(DocumentModel docModel,
                                   String text,
                                   String author)

Description copied from interface: CommentManager

Creates a comment document model, filling its properties with given info and linking it to given document.

Parameters:

docModel - the document to comment

text - the comment content

author - the comment author

Returns:

the comment document model.

createComment

public DocumentModel createComment(DocumentModel docModel,
                                   DocumentModel commentModel)
                            throws CommentSecurityException

Description copied from interface: CommentManager

Creates a comment document model, filling its properties with given info and linking it to given document.

Parameters:

docModel - the document to comment

commentModel - the comment document model

Returns:

the created comment document model.

Throws:

CommentSecurityException - if the current user does not have the right permissions on the document to comment.

createComment

public DocumentModel createComment(DocumentModel docModel,
                                   DocumentModel parent,
                                   DocumentModel child)

Description copied from interface: CommentManager

Creates a comment document model, filling its properties with given info and linking it to given document.

Parameters:

docModel - the document to comment

parent - the comment parent document model

child - the comment child document model

Returns:

the created comment document model.

deleteComment

public void deleteComment(DocumentModel docModel,
                          DocumentModel comment)

Description copied from interface: CommentManager

Deletes a comment.

Parameters:

docModel - the comment document model

comment - the comment

getDocumentsForComment

public List<DocumentModel> getDocumentsForComment(DocumentModel comment)

Description copied from interface: CommentManager

Gets documents in relation with a particular comment.

Parameters:

comment - the comment

Returns:

the list of documents

getThreadForComment

public DocumentModel getThreadForComment(DocumentModel comment)
                                  throws CommentSecurityException

Description copied from interface: CommentManager

Gets thread in relation with a given comment (post or comment).

Parameters:

comment - the comment

Returns:

the thread

Throws:

CommentSecurityException - if the current user does not have the right permissions on the commented document.

createLocatedComment

public DocumentModel createLocatedComment(DocumentModel docModel,
                                          DocumentModel comment,
                                          String path)

Description copied from interface: CommentManager

Creates a comment document model. It gives opportunity to save the comments in a specified location.

Parameters:

docModel - the document to comment

comment - the comment content

path - the location path

Returns:

the comment document model.

createComment

public Comment createComment(CoreSession session,
                             Comment comment)
                      throws CommentNotFoundException,
                             CommentSecurityException

Description copied from interface: CommentManager

Creates a comment.

Parameters:

session - the core session

Returns:

the created comment

Throws:

CommentNotFoundException - if the document to comment, i.e. comment's parent, does not exist.

CommentSecurityException - if the current user does not have the right permissions on the document to comment.

getComment

public Comment getComment(CoreSession session,
                          String commentId)
                   throws CommentNotFoundException,
                          CommentSecurityException

Description copied from interface: CommentManager

Gets a comment.

Parameters:

session - the core session

commentId - the comment id

Returns:

the comment

Throws:

CommentNotFoundException - if the comment does not exist

CommentSecurityException - if the current user does not have the right permissions on the commented document.

getComments

public PartialList<Comment> getComments(CoreSession session,
                                        String documentId,
                                        Long pageSize,
                                        Long currentPageIndex,
                                        boolean sortAscending)
                                 throws CommentSecurityException

Description copied from interface: CommentManager

Gets all comments for a document.

Parameters:

session - the core session

documentId - the document id

pageSize - the page size to query, give null or 0 to disable pagination

currentPageIndex - the page index to query, give null or 0 to disable pagination

sortAscending - whether to sort ascending or descending

Returns:

the list of comments, ordered by comment's creation date and according to sortAscending parameter, or an empty list if no comment is found.

Throws:

CommentSecurityException - if the current user does not have the right permissions on the commented document.

updateComment

public Comment updateComment(CoreSession session,
                             String commentId,
                             Comment comment)
                      throws CommentNotFoundException

Description copied from interface: CommentManager

Updates a comment.

Parameters:

session - the core session

commentId - the comment id

comment - the updated comment

Returns:

the updated comment

Throws:

CommentNotFoundException - if no comment was found with the given id.

deleteComment

public void deleteComment(CoreSession session,
                          String commentId)
                   throws CommentNotFoundException,
                          CommentSecurityException

Description copied from interface: CommentManager

Deletes a comment.

Parameters:

session - the core session

commentId - the comment id

Throws:

CommentNotFoundException - if no comment was found with the given id.

CommentSecurityException - if the current user does not have the right permissions on the commented document.

getExternalComment

public Comment getExternalComment(CoreSession session,
                                  String entityId)
                           throws CommentNotFoundException

Description copied from interface: CommentManager

Gets a comment generated by an external service.

Parameters:

session - the core session

entityId - the external entity id

Returns:

the comment

Throws:

CommentNotFoundException - if no comment was found with the given external entity id.

updateExternalComment

public Comment updateExternalComment(CoreSession session,
                                     String entityId,
                                     Comment comment)
                              throws CommentNotFoundException

Description copied from interface: CommentManager

Updates an external comment.

Parameters:

session - the core session

entityId - the external entity id

comment - the comment containing the modifications

Returns:

the updated comment

Throws:

CommentNotFoundException - if no comment was found with the given external entity id.

deleteExternalComment

public void deleteExternalComment(CoreSession session,
                                  String entityId)
                           throws CommentNotFoundException

Description copied from interface: CommentManager

Deletes an external comment.

Parameters:

session - the core session

entityId - the external entity id

Throws:

CommentNotFoundException - if no comment was found with the given external entity id.

hasFeature

public boolean hasFeature(CommentManager.Feature feature)

Description copied from interface: CommentManager

Checks if a feature is available.

getExternalCommentModel

protected DocumentModel getExternalCommentModel(CoreSession session,
                                                String entityId)

getCommentContainerPath

protected String getCommentContainerPath(CoreSession session,
                                         String commentedDocumentId)

getAncestorRef

protected DocumentRef getAncestorRef(CoreSession session,
                                     DocumentModel documentModel)

getThreadForComment

protected DocumentModel getThreadForComment(CoreSession session,
                                            DocumentModel comment)
                                     throws CommentSecurityException

Throws:

CommentSecurityException