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

Interface Comment<T extends CommentCollectionConfiguration>

All Superinterfaces:

SocialCollectionComponent, SocialComponent

All Known Subinterfaces:

Asset<T>, CalendarEvent, Document, JournalEntryComment, Post<T>, QnaPost, ReviewSocialComponent<C>

All Known Implementing Classes:

AbstractAsset, AbstractComment, AbstractPost, AbstractReview

public interface Comment<T extends CommentCollectionConfiguration>
extends SocialCollectionComponent

A Comment represents a comment created by a user (author) on a specific target (e.g. a page, asset or any node for that matter). The comments are contained within a CommentCollection (see #getParent(). A comment simply provides a comment text or "message" (see getMessage() and access to various meta data, such as creation date, who created it, etc.

Comments support attachments, i.e. files that are stored as part of a comment, e.g. a preview image if the comment is used to annotate an image.

Comments can also support reply to a comment

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Comment.ModeratorActions
static interface	Comment.ModeratorStatus
static interface	Comment.Tag

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMMENT_RESOURCETYPE The comment resourcetype.
static String	COMMENTCOLLECTION_RESOURCETYPE The commentcollection resourcetype.
static String	JSON_EXTENSION JSON extension.
static String	NODE_TYPE The comment node type.
static String	PROP_APPROVED The property name for the approval status.
static String	PROP_REFERER Request paramter and header name for Referrer Url.
static String	PROP_SPAM The property name for the spam flag.
static String	PROP_USE_REFERRER_URL The property name for use referrer as the @link getFriendlyUrl() value.
static String	SOCO_SELECTOR GET Selector.

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

DEFAULT_SELECTOR, INDEX_SELECTOR, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
Attachment	getAttachment(String name) Retrieve an attachment of this comment by its file name.
Map<String,Attachment>	getAttachments() Retrieves a map, an entry of which represents a file-name/attachment pair.
User	getAuthor() Returns the author's identifying name that represents the author of this comment.
boolean	getCanDelete()
boolean	getCanEdit()
boolean	getCanReply()
boolean	getCanTranslate() Check if the UGC language is the same as the Page language.
T	getConfiguration() Get the configuration for this comment
Calendar	getCreated() The time stamp this comment was created.
String	getCurrentUserFlagText()
List<FlagReason>	getFlagReasons()
String	getMessage() Retrieves the message of this comment.
Comment.ModeratorActions	getModeratorActions()
Comment.ModeratorStatus	getModeratorStatus() This only available if the current user is a moderator
PageInfo	getPageInfo() Gets information about the pages for this collection.
String	getParentId() Get this comment parent id.
Calendar	getPublishDate() Returns the scheduled publish date.
String	getReferrerUrl()
String	getSourceComponentId()
List<Comment.Tag>	getTags()
String	getTranslationAttribution()
String	getTranslationDescription()
String	getTranslationDisplay()
String	getTranslationTitle()
boolean	getUseFlagReasons()
SocialComponent	getVotes()
boolean	isApproved() Checks whether this comment is approved (in case comments are moderated).
boolean	isClosed()
boolean	isDraft() Checks if is draft.
boolean	isFlaggedByUser()
boolean	isScheduled() Checks if comment is scheduled to be published later.
boolean	isTopLevel()
boolean	isUserModerator()
boolean	isVisible()

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, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Field Detail

JSON_EXTENSION

static final String JSON_EXTENSION

JSON extension.

See Also:

Constant Field Values

SOCO_SELECTOR

static final String SOCO_SELECTOR

GET Selector.

See Also:

Constant Field Values

COMMENT_RESOURCETYPE

static final String COMMENT_RESOURCETYPE

The comment resourcetype.

See Also:

Constant Field Values

COMMENTCOLLECTION_RESOURCETYPE

static final String COMMENTCOLLECTION_RESOURCETYPE

The commentcollection resourcetype.

See Also:

Constant Field Values

NODE_TYPE

static final String NODE_TYPE

The comment node type.

See Also:

Constant Field Values

PROP_APPROVED

static final String PROP_APPROVED

The property name for the approval status.

See Also:

Constant Field Values

PROP_SPAM

static final String PROP_SPAM

The property name for the spam flag.

See Also:

Constant Field Values

PROP_USE_REFERRER_URL

static final String PROP_USE_REFERRER_URL

The property name for use referrer as the @link getFriendlyUrl() value. This is used for pages with suffix in its url.

See Also:

Constant Field Values

PROP_REFERER

static final String PROP_REFERER

Request paramter and header name for Referrer Url.

See Also:

Constant Field Values

Method Detail

getAttachment

Attachment getAttachment(String name)

Retrieve an attachment of this comment by its file name.

Parameters:

name - The file name of the attachment.

Returns:

A ResourceID representing the attachment, or null if no attachment with the given name exists.

getAuthor

User getAuthor()

Returns the author's identifying name that represents the author of this comment.

Returns:

The User representing the author name.

getAttachments

Map<String,Attachment> getAttachments()

Retrieves a map, an entry of which represents a file-name/attachment pair. The map contains all the attachments of the comment.

Returns:

A Map representing the available attachments, or an empty map if no attachments are present.

getCreated

Calendar getCreated()

The time stamp this comment was created.

Returns:

A Calendar representing creation time.

getMessage

String getMessage()

Retrieves the message of this comment.

Returns:

A String representing the message.

isTopLevel

boolean isTopLevel()

Returns:

true, if the comment is a top level comment; false, if the comment is a reply to another comment.

isApproved

boolean isApproved()

Checks whether this comment is approved (in case comments are moderated).

Returns:

true if comment is approved or unmoderated, false otherwise

getCanEdit

boolean getCanEdit()

Returns:

true if the Edit action button should be displayed

getCanDelete

boolean getCanDelete()

Returns:

true if the Delete action button should be displayed

getParentId

String getParentId()

Get this comment parent id.

Returns:

this comment parent id.

getCanTranslate

boolean getCanTranslate()

Check if the UGC language is the same as the Page language.

Returns:

true if the ugc language is detected and enabled and different than the page language.

isUserModerator

boolean isUserModerator()

Returns:

true if the current user is a moderator.

getFlagReasons

List<FlagReason> getFlagReasons()

Returns:

a list of the reasons for which users have flagged this comment.

isVisible

boolean isVisible()

Returns:

true if the comment should be visible, given the current user, the state of the comment, and the state of the comment system.

isClosed

boolean isClosed()

Returns:

true if the comment is closed, false otherwise.

isScheduled

boolean isScheduled()

Checks if comment is scheduled to be published later.

Returns:

true, if is scheduled to be published later, false otherwise.

isDraft

boolean isDraft()

Checks if is draft.

Returns:

true, if is draft

getPublishDate

Calendar getPublishDate()

Returns the scheduled publish date.

Returns:

The scheduled publish date of the topic or null if not found.

getTags

List<Comment.Tag> getTags()

getVotes

SocialComponent getVotes()

Returns:

voting component

getCurrentUserFlagText

String getCurrentUserFlagText()

Returns:

the text the current user flagged this comment with; an empty String if it was flagged with no text; or null, if the current user did not flag this comment.

getCanReply

boolean getCanReply()

Returns:

true if the reply button should be displayed.

getModeratorStatus

Comment.ModeratorStatus getModeratorStatus()

This only available if the current user is a moderator

Returns:

the comment moderator status

getModeratorActions

Comment.ModeratorActions getModeratorActions()

Returns:

the Comment.ModeratorActions

getConfiguration

T getConfiguration()

Get the configuration for this comment

Returns:

the configuration

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

getUseFlagReasons

boolean getUseFlagReasons()

Returns:

boolean true if flag reasons are used, either from a list or custom.

isFlaggedByUser

boolean isFlaggedByUser()

Returns:

boolean true if the current user has flagged this content.

getSourceComponentId

String getSourceComponentId()

Returns:

a String that points to the location of the component that created this comment.

getTranslationTitle

String getTranslationTitle()

Returns:

a String that is the translation of the title of the discussion in page language.

getTranslationDescription

String getTranslationDescription()

Returns:

a String that is the translation of the comment in page language.

getTranslationAttribution

String getTranslationAttribution()

Returns:

a String that is the translation attribution( translator provider name ).

getTranslationDisplay

String getTranslationDisplay()

Returns:

a String that is the display format of translation and the comment.

getReferrerUrl

String getReferrerUrl()

Returns:

a String that is the referrer url for the page that contains this comment. This is only applicable if the PROP_USE_REFERRER_URL configuration is set to true.