com.adobe.cq.social.commons.listing

Interface CommentListProvider<E>

public interface CommentListProvider<E>

Comments node type are sorted in different ordered for different component. The CommentListProvider allows a client to obtain the children of a resource sorted in the right order of its usage.

Method Summary

Modifier and Type	Method and Description
CommentListCollection<E>	getComments(Resource resource, QueryRequestInfo listInfo) Get a subset of Comment of the specified root resource as defined by the given offset and size.
java.lang.String[]	getSupportedResourceType() Get the resource types this provider supports

Method Detail

getComments

CommentListCollection<E> getComments(Resource resource,
                                     QueryRequestInfo listInfo)

Get a subset of Comment of the specified root resource as defined by the given offset and size. The comments are returned in chronological order.

Parameters:

resource - the target resource.

offset - the offset starting from 0.

size - the max number of elements to return.

reversedOrder - specifies the list is sorted in chronological order or not. This parameter only supports if the list provider supports sorting.

commentIndexElementFactory - the CommentIndexElementFactory used to create Comment object from an IndexElement.

Returns:

The list of comments with the specified offset and size.

getSupportedResourceType

java.lang.String[] getSupportedResourceType()

Get the resource types this provider supports

Returns:

a list resource type this provider supports.