Package com.atlassian.confluence.dmz.pages

Interface CommentManagerInternal

All Superinterfaces:

CommentManager, ContentEntityManager

All Known Implementing Classes:

DefaultCommentManager

@ParametersAreNonnullByDefault
public interface CommentManagerInternal
extends CommentManager

DMZ version of the CommentManager interface; see the package-info.java for rationale.

Since:

9.0

Field Summary

Fields inherited from interface com.atlassian.confluence.core.ContentEntityManager

ITERATE_ALL

Method Summary

Modifier and Type	Method	Description
long	countCommentByStatuses(List<ContentStatus> contentStatuses)	Retrieve the latest content count of specific content type for a given space with a particular status.
long	countSpaceCommentByStatuses(Space space, List<ContentStatus> contentStatuses)	Retrieve the latest content count of specific content type for a given space with a particular status.
@NonNull PageResponse<Comment>	getFilteredChildren(Comment comment, LimitedRequest pageRequest, Depth depth, Predicate<? super Comment> filter)	Returns the children of a comment, limited to the pagination requested.
@NonNull PageResponse<Comment>	getFilteredContainerComments(long containerId, LimitedRequest pageRequest, Depth depth, Predicate<? super Comment> filter)	Returns the children comments of a ContentEntityObject, limited to the pagination requested.
@NonNull PageResponse<Comment>	scanFilteredComments(Space space, List<ContentStatus> statuses, LimitedRequest pageRequest, Predicate<? super Comment>... filter)	Retrieves all the existing comments associated with the instance of Confluence, while applying the specified pagination parameters to limit the number of results returned in each request.
@NonNull PageResponse<Comment>	scanFilteredComments(List<ContentStatus> statuses, LimitedRequest pageRequest, Predicate<? super Comment>... filter)	Retrieves all the current comments within the specified space, with the results limited according to the provided pagination parameters.

Methods inherited from interface com.atlassian.confluence.pages.CommentManager

addCommentToObject, addCommentToObject, addCommentToPage, countAllCommentVersions, countComments, countComments, countUnresolvedComments, getComment, getPageComments, getPageComments, getPageLevelComments, getRecentlyUpdatedComments, removeCommentFromObject, removeCommentFromPage, updateCommentContent

Methods inherited from interface com.atlassian.confluence.core.ContentEntityManager

getById, getContributionStatusByUser, getNextVersion, getOtherVersion, getPageAndBlogPostsVersionsLastEditedByUser, getPageAndBlogPostsVersionsLastEditedByUserIncludingDrafts, getPreviousVersion, getRecentlyAddedEntities, getRecentlyModifiedEntities, getRecentlyModifiedEntitiesForUser, getRecentlyModifiedForChangeDigest, getVersionHistorySummaries, getVersionsLastEditedByUser, refreshContentEntity, removeContentEntity, removeHistoricalVersion, revertContentEntityBackToVersion, saveContentEntity, saveContentEntity, saveNewVersion, saveNewVersion

Method Details

getFilteredChildren

@NonNull PageResponse<Comment> getFilteredChildren(Comment comment,
 LimitedRequest pageRequest,
 Depth depth,
 Predicate<? super Comment> filter)

Returns the children of a comment, limited to the pagination requested.

Parameters:

comment - the comment to find children for

pageRequest - the pagination requested

depth - the depth to return children to

filter - optional predicates used to filter the comments

Returns:

the paginated response of Comment entities

Since:

7.0.1

getFilteredContainerComments

@NonNull PageResponse<Comment> getFilteredContainerComments(long containerId,
 LimitedRequest pageRequest,
 Depth depth,
 Predicate<? super Comment> filter)

Returns the children comments of a ContentEntityObject, limited to the pagination requested.

Parameters:

containerId - the id of the container to find children for

pageRequest - the pagination requested

depth - the depth to return children to

filter - optional predicates used to filter the comments

Returns:

the paginated response of Comment entities

Since:

7.0.1

scanFilteredComments

@NonNull PageResponse<Comment> scanFilteredComments(Space space,
 List<ContentStatus> statuses,
 LimitedRequest pageRequest,
 Predicate<? super Comment>... filter)

Retrieves all the existing comments associated with the instance of Confluence, while applying the specified pagination parameters to limit the number of results returned in each request.

Parameters:

space - the space to locate comments in

statuses - list of content status which we are interested to fetch

pageRequest - the pagination requested

filter - a Predicate to apply to the results before returning

Returns:

the paginated response of Comment entities in the given space

Since:

9.2.5

scanFilteredComments

@NonNull PageResponse<Comment> scanFilteredComments(List<ContentStatus> statuses,
 LimitedRequest pageRequest,
 Predicate<? super Comment>... filter)

Retrieves all the current comments within the specified space, with the results limited according to the provided pagination parameters.

Parameters:

statuses - list of content status which we are interested to fetch

pageRequest - the pagination requested

filter - a Predicate to apply to the results before returning

Returns:

the paginated response of Comment entities in any space

Since:

9.2.5

countSpaceCommentByStatuses

long countSpaceCommentByStatuses(Space space,
 List<ContentStatus> contentStatuses)

Retrieve the latest content count of specific content type for a given space with a particular status.

Parameters:

space - the space

contentStatuses - the statuses of the content being retrieved (e.g. ContentEntityObject.DELETED

Returns:

the number of content objects with that status in that space

Since:

9.2.5

countCommentByStatuses

long countCommentByStatuses(List<ContentStatus> contentStatuses)

Retrieve the latest content count of specific content type for a given space with a particular status.

Parameters:

contentStatuses - the statuses of the content being retrieved (e.g. ContentEntityObject.DELETED

Returns:

the number of content objects with that status in that space

Since:

9.2.5