org.nuxeo.ecm.platform.comment.impl

Class AbstractCommentManager

java.lang.Object

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

All Implemented Interfaces:

CommentManager

Direct Known Subclasses:

BridgeCommentManager, CommentManagerImpl, PropertyCommentManager

public abstract class AbstractCommentManager
extends Object
implements CommentManager

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	COMMENTS_DIRECTORY

Constructor Summary

Constructors

Constructor and Description
AbstractCommentManager()

Method Summary

Modifier and Type	Method and Description
protected Collection<String>	computeAncestorIds(CoreSession session, String parentId)
protected NuxeoPrincipal	getAuthor(DocumentModel docModel)
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.
List<DocumentModel>	getComments(DocumentModel docModel) Gets comments of a document.
List<DocumentModel>	getComments(DocumentModel docModel, DocumentModel parent) Get comments of a document.
protected void	notifyEvent(CoreSession session, String eventType, DocumentModel commentedDoc, DocumentModel comment)
protected void	setCommentPermissions(CoreSession session, DocumentModel documentModel)
protected void	setFolderPermissions(CoreSession session, DocumentModel documentModel)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.platform.comment.api.CommentManager

createComment, createComment, createComment, createComment, createComment, createLocatedComment, deleteComment, deleteComment, deleteExternalComment, getComment, getComments, getComments, getDocumentsForComment, getExternalComment, getThreadForComment, hasFeature, updateComment, updateExternalComment

Field Detail

COMMENTS_DIRECTORY

protected static final String COMMENTS_DIRECTORY

See Also:

Constant Field Values

Constructor Detail

AbstractCommentManager

public AbstractCommentManager()

Method Detail

getComments

public List<DocumentModel> getComments(DocumentModel docModel)

Description copied from interface: CommentManager

Gets comments of a document.

Specified by:

getComments in interface CommentManager

Parameters:

docModel - the document model

Returns:

the list of comments

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

Parameters:

docModel - the document model

parent - the parent document model

Returns:

the list of comments

getComments

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

Description copied from interface: CommentManager

Gets all comments for a document.

Specified by:

getComments in interface CommentManager

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.

getComments

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

Description copied from interface: CommentManager

Gets all comments for a document.

Specified by:

getComments in interface CommentManager

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.

getComments

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

Description copied from interface: CommentManager

Gets all comments for a document.

Specified by:

getComments in interface CommentManager

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.

notifyEvent

protected void notifyEvent(CoreSession session,
                           String eventType,
                           DocumentModel commentedDoc,
                           DocumentModel comment)

getAuthor

protected NuxeoPrincipal getAuthor(DocumentModel docModel)

setFolderPermissions

protected void setFolderPermissions(CoreSession session,
                                    DocumentModel documentModel)

setCommentPermissions

protected void setCommentPermissions(CoreSession session,
                                     DocumentModel documentModel)

computeAncestorIds

protected Collection<String> computeAncestorIds(CoreSession session,
                                                String parentId)