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

Interface CommentCollection<C extends Comment,T extends CommentCollectionConfiguration>

Type Parameters:

C -

All Superinterfaces:

SocialCollectionComponent, SocialComponent

All Known Subinterfaces:

Forum<P,C>, ReviewCollectionSocialComponent<C,T>

All Known Implementing Classes:

AbstractCommentCollection, AbstractForum, AbstractReviewCollection

public interface CommentCollection<C extends Comment,T extends CommentCollectionConfiguration>
extends SocialCollectionComponent

A CommentCollection represents a collection of Comments. Comments can be added to and removed from the collection. A collection is tied to a specific target (e.g. the page, asset or node that was commented on) - see #getTarget().

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.
Calendar	getLastModified() Returns the moment in time this collection was last modified.
PageInfo	getPageInfo() Gets information about the pages for this collection.
boolean	isTaggingAllowed() Checks if is tagging allowed.

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

getItems, getTotalSize, setPagination, setSortedOrder

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

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

Method Detail

getCreated

Calendar getCreated()

Returns the moment in time this collection was created.

Returns:

The calendar representing the creation date/time.

getLastModified

Calendar getLastModified()

Returns the moment in time this collection was last modified.

Returns:

The calendar representing the last modification.

getPageInfo

PageInfo getPageInfo()

Gets information about the pages for this collection. This can be used by the page block helper to easily render various pagination UIs.

Returns:

information about the pagination system

isTaggingAllowed

boolean isTaggingAllowed()

Checks if is tagging allowed.

Returns:

true, if is tagging allowed

getConfiguration

T getConfiguration()

Get the configuration for this collection

createConfiguration

T createConfiguration(Resource resource,
                    CommentSystem cs)

Create configuration for the specified resource

Parameters:

resource - the

cs - The CommentSystem of the comment

Returns: