com.adobe.cq.social.commons.comments.listing

Interface CommentSocialComponentListProvider

public interface CommentSocialComponentListProvider

An interface that defines comment list providers that can retrieve a list of comments based on a specific set of constraints like query/sort/resource type, etc.

Method Summary

Modifier and Type	Method and Description
boolean	acceptQuery(QueryRequestInfo listInfo)
boolean	checkResource(Resource commentCollectionResource, SocialUtils socialUtils) Allows a caller to determine whether this provider can retrieve the list of comments for the given resource.
<C extends Comment,T extends CommentCollectionConfiguration> CommentSocialComponentList	getCommentSocialComponentList(CommentCollection<C,T> commentCollection, QueryRequestInfo listInfo, ClientUtilities clientUtils)
<C extends Comment> CommentSocialComponentList	getCommentSocialComponentList(C comment, QueryRequestInfo listInfo, ClientUtilities clientUtils)
java.util.List<java.lang.String>	getSupportedResourceType()

Method Detail

getCommentSocialComponentList

<C extends Comment,T extends CommentCollectionConfiguration> CommentSocialComponentList getCommentSocialComponentList(CommentCollection<C,T> commentCollection,
                                                                                                                      QueryRequestInfo listInfo,
                                                                                                                      ClientUtilities clientUtils)

Type Parameters:

C - comment

T - CommentCollectionConfiguration

Parameters:

commentCollection - - the comment collection instance for which the list of comments is to be retrieved.

listInfo - - parameters that define the list

clientUtils - - an instance of ClientUtilities

Returns:

a CommentSocialComponentList that contains the list of comments retrieved

getCommentSocialComponentList

<C extends Comment> CommentSocialComponentList getCommentSocialComponentList(C comment,
                                                                             QueryRequestInfo listInfo,
                                                                             ClientUtilities clientUtils)

Type Parameters:

C - comment

Parameters:

comment - - the comment instance for which the list of comments is to be retrieved.

listInfo - - parameters that define the list

clientUtils - - an instance of ClientUtilities

Returns:

a CommentSocialComponentList that contains the list of comments retrieved

checkResource

boolean checkResource(Resource commentCollectionResource,
                      SocialUtils socialUtils)

Allows a caller to determine whether this provider can retrieve the list of comments for the given resource.

Parameters:

commentCollectionResource - - the resource for which a list of comments is to be retrieved.

socialUtils - - an instance of SocialUtils

Returns:

true if this provider can retrieve a list for the resource, false otherwise.

getSupportedResourceType

java.util.List<java.lang.String> getSupportedResourceType()

Returns:

a list of resource types for which this provider can retrieve a list of comments for.

acceptQuery

boolean acceptQuery(QueryRequestInfo listInfo)

Parameters:

listInfo - - the list parameters for which provider might have to retireve a list for

Returns:

true, if the provider can handle the constrains (like sort criteria, filter parameters) specified in the listInfo, false otherwise.