com.atlassian.confluence.pages
Interface CommentManager

All Superinterfaces:
ContentEntityManager
All Known Subinterfaces:
CommentManagerInternal
All Known Implementing Classes:
DefaultCommentManager

public interface CommentManager
extends ContentEntityManager

Manager for page comments.


Field Summary
 
Fields inherited from interface com.atlassian.confluence.core.ContentEntityManager
ITERATE_ALL
 
Method Summary
 Comment addCommentToObject(ContentEntityObject ceo, Comment parent, String content)
           
 Comment addCommentToObject(ContentEntityObject ceo, Comment parent, String content, NewCommentDeduplicator commentDeduplicator)
          Add a new comment if the given deduplicator determines that it's not a duplicate, or just return the existing duplicate otherwise.
 Comment addCommentToPage(AbstractPage page, Comment parent, String content)
          Deprecated. 
 Map<com.atlassian.bonnie.Searchable,Integer> countComments(Collection<? extends com.atlassian.bonnie.Searchable> searchables)
           
 int countComments(com.atlassian.bonnie.Searchable searchable)
           
 Map<Long,Integer> countUnresolvedComments(Collection<Long> containerIds)
          Count unresolved comments of comment containers.
 Comment getComment(long id)
           
 List<Comment> getPageComments(long pageId, Date since)
          The service get all page comments (page level comments and inline comments)
 List<Comment> getPageComments(long pageId, Date since, String ignoreUsername)
          The service get all page comments (page level comments and inline comments) from a particular date except for comments by the given username.
 List<Comment> getPageLevelComments(long pageId, Date since)
          The service get all page level comments
 Iterator getRecentlyUpdatedComments(Space space, int maxResults)
           
 void removeCommentFromObject(long id)
           
 void removeCommentFromPage(long id)
          Deprecated. 
 void updateCommentContent(Comment comment, String content)
           
 
Methods inherited from interface com.atlassian.confluence.core.ContentEntityManager
getById, getNextVersion, getOtherVersion, getPreviousVersion, getRecentlyAddedEntities, getRecentlyModifiedEntities, getRecentlyModifiedEntitiesForUser, getRecentlyModifiedForChangeDigest, getVersionHistorySummaries, refreshContentEntity, removeContentEntity, removeHistoricalVersion, revertContentEntityBackToVersion, saveContentEntity, saveContentEntity, saveNewVersion, saveNewVersion, setEventManager, updateContentLinkingTo, updateOutgoingLinksInContent, updateSingleContentLinkinTo, updateSingleContentLinkinTo
 

Method Detail

getComment

Comment getComment(long id)

addCommentToPage

@Deprecated
Comment addCommentToPage(AbstractPage page,
                                    Comment parent,
                                    String content)
Deprecated. 


addCommentToObject

Comment addCommentToObject(ContentEntityObject ceo,
                           Comment parent,
                           String content)

addCommentToObject

Comment addCommentToObject(ContentEntityObject ceo,
                           Comment parent,
                           String content,
                           NewCommentDeduplicator commentDeduplicator)
Add a new comment if the given deduplicator determines that it's not a duplicate, or just return the existing duplicate otherwise.

Since:
5.6

updateCommentContent

void updateCommentContent(Comment comment,
                          String content)

removeCommentFromPage

@Deprecated
void removeCommentFromPage(long id)
Deprecated. 


removeCommentFromObject

void removeCommentFromObject(long id)

getRecentlyUpdatedComments

Iterator getRecentlyUpdatedComments(Space space,
                                    int maxResults)

getPageComments

List<Comment> getPageComments(long pageId,
                              Date since)
The service get all page comments (page level comments and inline comments)

Parameters:
pageId - page id of comment
since - comment time
Returns:
all comment

getPageComments

List<Comment> getPageComments(long pageId,
                              Date since,
                              String ignoreUsername)
The service get all page comments (page level comments and inline comments) from a particular date except for comments by the given username.

Parameters:
pageId - page id of comment
since - comment time
ignoreUsername - username excepted
Returns:
all comment

getPageLevelComments

List<Comment> getPageLevelComments(long pageId,
                                   Date since)
The service get all page level comments

Parameters:
pageId - page id of comment
since - comment time
Returns:
page level comments
Since:
5.6

countComments

Map<com.atlassian.bonnie.Searchable,Integer> countComments(Collection<? extends com.atlassian.bonnie.Searchable> searchables)

countComments

int countComments(com.atlassian.bonnie.Searchable searchable)

countUnresolvedComments

Map<Long,Integer> countUnresolvedComments(Collection<Long> containerIds)
Count unresolved comments of comment containers.

Parameters:
containerIds - the list of comment containers ids
Returns:
The map of container id and its unresolved comment count
Since:
5.7


Copyright © 2003–2015 Atlassian. All rights reserved.