com.adobe.cq.social.commons.comments.api

Class AbstractCommentCollection<C extends Comment,T extends CommentCollectionConfiguration>

java.lang.Object

com.adobe.cq.social.commons.client.api.BaseSocialComponent

com.adobe.cq.social.commons.comments.api.AbstractCommentCollection<C,T>

Type Parameters:

C - any SocialComponent type that extends the Comment data type.

All Implemented Interfaces:

SocialCollectionComponent, SocialComponent, CommentCollection<C,T>

Direct Known Subclasses:

AbstractForum, AbstractReviewCollection

public abstract class AbstractCommentCollection<C extends Comment,T extends CommentCollectionConfiguration>
extends BaseSocialComponent
implements CommentCollection<C,T>

Base SocialComponentCollection class which maintains a list of Comment.

Constructor Summary

Constructors

Constructor and Description
AbstractCommentCollection(Resource resource, ClientUtilities clientUtils, CommentSocialComponentListProviderManager commentListProviderManager) Constructor using the specified Resource which should be the root of the collection without paging specification.
AbstractCommentCollection(Resource resource, ClientUtilities clientUtils, QueryRequestInfo queryInfo, CommentSocialComponentListProviderManager commentListProviderManager) Construct a CommentCollection using the specified Resource which should be the root of the collection.
AbstractCommentCollection(ResourceID id, ResourceResolver resolver, ClientUtilities clientUtils, CommentSocialComponentListProviderManager commentListProviderManager) Constructor using the specified ResourceID which should be the root of the collection without paging specification.

Method Summary

Methods

Modifier and Type	Method and Description
T	createConfiguration(Resource resource, CommentSystem cs) Create configuration for the specified resource
T	getConfiguration() Get the configuration for this collection
Calendar	getCreated() Returns the moment in time this collection was created.
List<Object>	getItems() Get the comments of this CommentCollection base on the pagination configuration.
Calendar	getLastModified() Returns the moment in time this collection was last modified.
PageInfo	getPageInfo() Gets information about the pages for this collection.
int	getTotalSize() Get total size of the collection.
boolean	isTaggingAllowed() Checks if is tagging allowed.
void	setPagination(CollectionPagination pagination) Set the collection list range.
void	setSortedOrder(CollectionSortedOrder sortedOrder) Set the collection sorted order.

Methods inherited from class com.adobe.cq.social.commons.client.api.BaseSocialComponent

getAsMap, getId, getProperties, getResource, getResourceType, getUrl, toJSONString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adobe.cq.social.commons.client.api.SocialComponent

getAsMap, getId, getProperties, getResource, getResourceType, getUrl, toJSONString

Constructor Detail

AbstractCommentCollection

public AbstractCommentCollection(ResourceID id,
                         ResourceResolver resolver,
                         ClientUtilities clientUtils,
                         CommentSocialComponentListProviderManager commentListProviderManager)

Constructor using the specified ResourceID which should be the root of the collection without paging specification. Paging information is not created until the pagination is specified.

Parameters:

id - the resource id of the CommentCollection

resolver - the resource resolver used to obtain the resource in the JCR.

clientUtils - the clientUtils

See Also:

setPagination(CollectionPagination)

AbstractCommentCollection

public AbstractCommentCollection(Resource resource,
                         ClientUtilities clientUtils,
                         CommentSocialComponentListProviderManager commentListProviderManager)

Constructor using the specified Resource which should be the root of the collection without paging specification. Paging information is not created until the pagination is specified.

Parameters:

resource - the resource.

clientUtils - the clientUtils

See Also:

setPagination(CollectionPagination)

AbstractCommentCollection

public AbstractCommentCollection(Resource resource,
                         ClientUtilities clientUtils,
                         QueryRequestInfo queryInfo,
                         CommentSocialComponentListProviderManager commentListProviderManager)

Construct a CommentCollection using the specified Resource which should be the root of the collection.

Parameters:

resource - the resource where the CommentCollection is located

clientUtils - the clientUtilities instance

Method Detail

setPagination

public void setPagination(CollectionPagination pagination)

Set the collection list range. If this is not set, then the return list will start at offset 0 and the default size.

Specified by:

setPagination in interface SocialCollectionComponent

Parameters:

pagination - pagination configuration

getCreated

public Calendar getCreated()

Returns the moment in time this collection was created.

Specified by:

getCreated in interface CommentCollection<C extends Comment,T extends CommentCollectionConfiguration>

Returns:

The calendar representing the creation date/time.

getLastModified

public Calendar getLastModified()

Returns the moment in time this collection was last modified.

Specified by:

getLastModified in interface CommentCollection<C extends Comment,T extends CommentCollectionConfiguration>

Returns:

The calendar representing the last modification.

getTotalSize

public int getTotalSize()

Get total size of the collection.

Specified by:

getTotalSize in interface SocialCollectionComponent

Returns:

the size of the collection.

getItems

public List<Object> getItems()

Get the comments of this CommentCollection base on the pagination configuration.

Specified by:

getItems in interface SocialCollectionComponent

Returns:

List