org.nuxeo.ecm.platform.comment.api

Interface CommentManager

All Known Implementing Classes:

AbstractCommentManager, BridgeCommentManager, CommentManagerImpl, PropertyCommentManager

public interface CommentManager

Author:

George Lefter

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CommentManager.Feature Features of the implementation of the service.

Method Summary

Modifier and Type	Method and Description
Comment	createComment(CoreSession session, Comment comment) Creates a comment.
DocumentModel	createComment(DocumentModel docModel, DocumentModel comment) 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) Deprecated. since 10.3, use createComment(CoreSession, Comment) instead.
DocumentModel	createComment(DocumentModel docModel, String comment) Deprecated. CommentManager cannot find the author if invoked remotely so one should use createComment(DocumentModel, String, String)
DocumentModel	createComment(DocumentModel docModel, String comment, String author) Deprecated. since 10.3, use createComment(CoreSession, Comment) instead.
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) Deprecated. since 10.3, use deleteComment(CoreSession, String) instead.
void	deleteExternalComment(CoreSession session, String entityId) Deletes an external comment.
Comment	getComment(CoreSession session, String commentId) Gets a comment.
List<DocumentModel>	getComments(CoreSession session, DocumentModel docModel) Gets comments of a document.
List<Comment>	getComments(CoreSession session, String documentId) Gets all comments for a document.
List<Comment>	getComments(CoreSession session, String documentId, boolean sortAscending) Gets all comments for a document.
PartialList<Comment>	getComments(CoreSession session, String documentId, Long pageSize, Long currentPageIndex) Gets all comments for 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) Gets comments of a document.
List<DocumentModel>	getComments(DocumentModel docModel, DocumentModel parent) Deprecated. since 10.3, use getComments(DocumentModel) instead.
List<DocumentModel>	getDocumentsForComment(DocumentModel comment) Deprecated. since 10.3, only used with deprecated implementation, no replacement.
Comment	getExternalComment(CoreSession session, String entityId) Gets a comment generated by an external service.
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.

Method Detail

getComments

List<DocumentModel> getComments(DocumentModel docModel)

Gets comments of a document.

Parameters:

docModel - the document model

Returns:

the list of comments

getComments

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

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

Since:

10.3

getComments

@Deprecated
List<DocumentModel> getComments(DocumentModel docModel,
                                            DocumentModel parent)

Deprecated. since 10.3, use getComments(DocumentModel) instead.

Get comments of a document.

Parameters:

docModel - the document model

parent - the parent document model

Returns:

the list of comments

createComment

@Deprecated
DocumentModel createComment(DocumentModel docModel,
                                        String comment)

Deprecated. CommentManager cannot find the author if invoked remotely so one should use createComment(DocumentModel, String, String)

Creates a comment.

Parameters:

docModel - the document to comment

comment - the comment content

createComment

@Deprecated
DocumentModel createComment(DocumentModel docModel,
                                        String comment,
                                        String author)

Deprecated. since 10.3, use createComment(CoreSession, Comment) instead.

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

Parameters:

docModel - the document to comment

comment - the comment content

author - the comment author

Returns:

the comment document model.

createComment

DocumentModel createComment(DocumentModel docModel,
                            DocumentModel comment)
                     throws CommentSecurityException

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

Parameters:

docModel - the document to comment

comment - 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

@Deprecated
DocumentModel createComment(DocumentModel docModel,
                                        DocumentModel parent,
                                        DocumentModel child)

Deprecated. since 10.3, use createComment(CoreSession, Comment) instead.

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

@Deprecated
void deleteComment(DocumentModel docModel,
                               DocumentModel comment)

Deprecated. since 10.3, use deleteComment(CoreSession, String) instead.

Deletes a comment.

Parameters:

docModel - the comment document model

comment - the comment

getDocumentsForComment

@Deprecated
List<DocumentModel> getDocumentsForComment(DocumentModel comment)

Deprecated. since 10.3, only used with deprecated implementation, no replacement.

Gets documents in relation with a particular comment.

Parameters:

comment - the comment

Returns:

the list of documents

getThreadForComment

DocumentModel getThreadForComment(DocumentModel comment)
                           throws CommentSecurityException

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.

Since:

5.5

createLocatedComment

DocumentModel createLocatedComment(DocumentModel docModel,
                                   DocumentModel comment,
                                   String path)
                            throws CommentSecurityException

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.

Throws:

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

createComment

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

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.

Since:

10.3

getComment

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

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.

Since:

10.3

getComments

List<Comment> getComments(CoreSession session,
                          String documentId)

Gets all comments for a document.

Parameters:

session - the core session

documentId - the document id

Returns:

the list of comments, ordered ascending by comment's creation date, or an empty list if no comment is found.

Since:

10.3

getComments

List<Comment> getComments(CoreSession session,
                          String documentId,
                          boolean sortAscending)

Gets all comments for a document.

Parameters:

session - the core session

documentId - the document id

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.

Since:

10.3

getComments

PartialList<Comment> getComments(CoreSession session,
                                 String documentId,
                                 Long pageSize,
                                 Long currentPageIndex)

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

Returns:

the list of comments, ordered ascending by comment's creation date, or an empty list if no comment is found.

Since:

10.3

getComments

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

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.

Since:

10.3

updateComment

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

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.

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

Since:

10.3

deleteComment

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

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.

Since:

10.3

getExternalComment

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

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.

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

Since:

10.3

updateExternalComment

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

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.

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

Since:

10.3

deleteExternalComment

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

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.

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

Since:

10.3

hasFeature

boolean hasFeature(CommentManager.Feature feature)

Checks if a feature is available.

Since:

10.3