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

Interface CommentCollection<C extends Comment,T extends CommentCollectionConfiguration>

Type Parameters:

C - comment

All Superinterfaces:

SocialCollectionComponent, SocialComponent

All Known Subinterfaces:

Calendar, FileLibrary<P,C>, Forum<P,C>, Journal, MessageBoxSocialComponent<P,C>, ReviewCollectionSocialComponent<C,T>

All Known Implementing Classes:

AbstractCommentCollection, AbstractFileLibrary, 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 com.adobe.cq.social.commons.impl.CommentInfo#getTarget().

Field Summary

Fields inherited from interface com.adobe.cq.social.scf.SocialComponent

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
T	getConfiguration() Get the configuration for this collection
java.util.Calendar	getCreated() Returns the moment in time this collection was created.
java.util.Calendar	getLastModified() Returns the moment in time this collection was last modified.
boolean	getMayPost()
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.scf.SocialCollectionComponent

getItems, getTotalSize, setPagination, setSortedOrder

Methods inherited from interface com.adobe.cq.social.scf.SocialComponent

getAsMap, getFriendlyUrl, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Method Detail

getCreated

java.util.Calendar getCreated()

Returns the moment in time this collection was created.

Returns:

The calendar representing the creation date/time.

getLastModified

java.util.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

Returns:

T

getMayPost

boolean getMayPost()

Returns:

true if the Post action button should be displayed