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

Class AbstractComment<T extends CommentCollectionConfiguration>

java.lang.Object

com.adobe.cq.social.scf.core.BaseSocialComponent

com.adobe.cq.social.commons.comments.api.AbstractComment<T>

All Implemented Interfaces:

Comment<T>, SocialCollectionComponent, SocialComponent

Direct Known Subclasses:

AbstractAsset, AbstractPost, AbstractReview

public abstract class AbstractComment<T extends CommentCollectionConfiguration>
extends BaseSocialComponent
implements Comment<T>

Nested Class Summary

Nested classes/interfaces inherited from interface com.adobe.cq.social.commons.comments.api.Comment

Comment.ModeratorActions, Comment.ModeratorStatus, Comment.Tag

Field Summary

Fields inherited from interface com.adobe.cq.social.commons.comments.api.Comment

COMMENT_RESOURCETYPE, COMMENTCOLLECTION_RESOURCETYPE, JSON_EXTENSION, NODE_TYPE, PROP_APPROVED, PROP_REFERER, PROP_SPAM, PROP_USE_REFERRER_URL, SOCO_SELECTOR

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

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, QUERY_SELECTOR, TRANSLATE_SELECTOR

Constructor Summary

Constructors

Constructor and Description
AbstractComment(Resource resource, ClientUtilities clientUtils, CommentSocialComponentListProviderManager commentListProviderManager) Construct a comment for the specified resource and client utilities.
AbstractComment(Resource resource, ClientUtilities clientUtils, QueryRequestInfo queryInfo, CommentSocialComponentListProviderManager commentListProviderManager) Constructor of a comment.

Method Summary

Modifier and Type	Method and Description
Attachment	getAttachment(java.lang.String name) Retrieve an attachment of this comment by its file name.
java.util.Map<java.lang.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.
java.util.Calendar	getCreated() The time stamp this comment was created.
java.lang.String	getCurrentUserFlagText()
java.util.List<FlagReason>	getFlagReasons()
java.lang.String	getFriendlyUrl() Get a url that can be used to display this component, most of the time, this is the page url that contains the component.
java.util.List<java.lang.Object>	getItems() Returns a list of children of this collection.
java.lang.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.
java.lang.String	getParent() Gets the parent path for the comment.
SocialComponent	getParentComponent() Gets the immediate parent of this component.
java.lang.String	getParentId() Get this comment parent id.
java.util.Calendar	getPublishDate() Returns the scheduled publish date.
java.lang.String	getReferrerUrl()
java.lang.String	getResourceType()
SocialComponent	getSourceComponent() Gets the SocialComponent that created this piece of UGC.
java.lang.String	getSourceComponentId()
java.lang.String	getState() Retrieves the state of this comment.
java.util.List<Comment.Tag>	getTags()
int	getTotalSize() Get total size of the collection.
java.lang.String	getTranslationAttribution()
java.lang.String	getTranslationDescription()
java.lang.String	getTranslationDisplay()
java.lang.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	isFeatured()
boolean	isFlaggedByUser()
boolean	isPinned()
boolean	isScheduled() Checks if comment is scheduled to be published later.
boolean	isTopLevel()
boolean	isUserModerator()
boolean	isVisible()
void	setPagination(CollectionPagination pagination) Set the collection list range.
void	setSortedOrder(CollectionSortedOrder sortedOrder) Set the collection sorted order.
void	setSortFields(java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortFields)
java.lang.String	toString()

Methods inherited from class com.adobe.cq.social.scf.core.BaseSocialComponent

buildJSONString, getAsMap, getId, getProperties, getProperty, getProperty, getResource, getUrl, toJSONString

Methods inherited from class java.lang.Object

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

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

getAsMap, getId, getProperties, getProperty, getProperty, getResource, getUrl, toJSONString

Constructor Detail

AbstractComment

public AbstractComment(Resource resource,
                       ClientUtilities clientUtils,
                       CommentSocialComponentListProviderManager commentListProviderManager)
                throws RepositoryException

Construct a comment for the specified resource and client utilities.

Parameters:

resource - the specified resource

clientUtils - the client utilities instance

commentListProviderManager - list manager to use for listing content

Throws:

RepositoryException - if an error occurs

AbstractComment

public AbstractComment(Resource resource,
                       ClientUtilities clientUtils,
                       QueryRequestInfo queryInfo,
                       CommentSocialComponentListProviderManager commentListProviderManager)
                throws RepositoryException

Constructor of a comment.

Parameters:

resource - the specified com.adobe.cq.social.commons.Comment

clientUtils - the client utilities instance

queryInfo - the query info.

commentListProviderManager - list manager to use for listing content

Throws:

RepositoryException - if an error occurs

Method Detail

getConfiguration

public T getConfiguration()

Description copied from interface: Comment

Get the configuration for this comment.

Specified by:

getConfiguration in interface Comment<T extends CommentCollectionConfiguration>

Returns:

the configuration

getAttachment

public Attachment getAttachment(java.lang.String name)

Retrieve an attachment of this comment by its file name.

Specified by:

getAttachment in interface Comment<T extends CommentCollectionConfiguration>

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

public User getAuthor()

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

Specified by:

getAuthor in interface Comment<T extends CommentCollectionConfiguration>

Returns:

The User representing the author name.

getState

public java.lang.String getState()

Retrieves the state of this comment.

Specified by:

getState in interface Comment<T extends CommentCollectionConfiguration>

Returns:

A String representing the state.

getAttachments

public java.util.Map<java.lang.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.

Specified by:

getAttachments in interface Comment<T extends CommentCollectionConfiguration>

Returns:

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

getCreated

public java.util.Calendar getCreated()

The time stamp this comment was created.

Specified by:

getCreated in interface Comment<T extends CommentCollectionConfiguration>

Returns:

A Calendar representing creation time.

getResourceType

public java.lang.String getResourceType()

Specified by:

getResourceType in interface SocialComponent

Overrides:

getResourceType in class BaseSocialComponent

Returns:

the resource type of the resource.

getMessage

public java.lang.String getMessage()

Retrieves the message of this comment.

Specified by:

getMessage in interface Comment<T extends CommentCollectionConfiguration>

Returns:

A String representing the message.

getParent

public java.lang.String getParent()

Gets the parent path for the comment.

Returns:

a string pointing to the externalized URL to the parent.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

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 - detail information to use

setSortedOrder

public void setSortedOrder(CollectionSortedOrder sortedOrder)

Set the collection sorted order.

Specified by:

setSortedOrder in interface SocialCollectionComponent

Parameters:

sortedOrder - the order definition of how the items should be sorted.

setSortFields

public void setSortFields(java.util.List<java.util.Map.Entry<java.lang.String,java.lang.Boolean>> sortFields)

isTopLevel

public boolean isTopLevel()

Specified by:

isTopLevel in interface Comment<T extends CommentCollectionConfiguration>

Returns:

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

isApproved

public boolean isApproved()

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

Specified by:

isApproved in interface Comment<T extends CommentCollectionConfiguration>

Returns:

true if comment is approved or unmoderated, false otherwise

getCanEdit

public boolean getCanEdit()

Specified by:

getCanEdit in interface Comment<T extends CommentCollectionConfiguration>

Returns:

true if the Edit action button should be displayed

getCanReply

public boolean getCanReply()

Specified by:

getCanReply in interface Comment<T extends CommentCollectionConfiguration>

Returns:

true if the reply button should be displayed.

getCanDelete

public boolean getCanDelete()

Specified by:

getCanDelete in interface Comment<T extends CommentCollectionConfiguration>

Returns:

true if the Delete action button should be displayed

getTotalSize

public int getTotalSize()

Get total size of the collection.

Specified by:

getTotalSize in interface SocialCollectionComponent

Returns:

the size of the collection.

getItems

public java.util.List<java.lang.Object> getItems()

Returns a list of children of this collection. Use setPagination() to set pagination properties before calling this method.

Specified by:

getItems in interface SocialCollectionComponent

Returns:

A List of children of this collection, or an empty list if no children are present. If the children is the first level child, then the child is embedded in the list, otherwise, the child url is included in the list.

getParentId

public java.lang.String getParentId()

Get this comment parent id.

Specified by:

getParentId in interface Comment<T extends CommentCollectionConfiguration>

Returns:

this comment parent id.

getSourceComponentId

public java.lang.String getSourceComponentId()

Specified by:

getSourceComponentId in interface Comment<T extends CommentCollectionConfiguration>

Returns:

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

getCanTranslate

public boolean getCanTranslate()

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

Specified by:

getCanTranslate in interface Comment<T extends CommentCollectionConfiguration>

Returns:

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

isUserModerator

public boolean isUserModerator()

Specified by:

isUserModerator in interface Comment<T extends CommentCollectionConfiguration>

Returns:

true if the current user is a moderator.

isVisible

public boolean isVisible()

Specified by:

isVisible in interface Comment<T extends CommentCollectionConfiguration>

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

public boolean isClosed()

Specified by:

isClosed in interface Comment<T extends CommentCollectionConfiguration>

Returns:

true if the comment is closed, false otherwise.

isPinned

public boolean isPinned()

Specified by:

isPinned in interface Comment<T extends CommentCollectionConfiguration>

Returns:

true if the comment is pinned, false otherwise.

isFeatured

public boolean isFeatured()

Specified by:

isFeatured in interface Comment<T extends CommentCollectionConfiguration>

Returns:

true if the comment is Featured, false otherwise.

isDraft

public boolean isDraft()

Checks if is draft.

Specified by:

isDraft in interface Comment<T extends CommentCollectionConfiguration>

Returns:

true, if is draft

isScheduled

public boolean isScheduled()

Checks if comment is scheduled to be published later.

Specified by:

isScheduled in interface Comment<T extends CommentCollectionConfiguration>

Returns:

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

getPublishDate

public java.util.Calendar getPublishDate()

Description copied from interface: Comment

Returns the scheduled publish date.

Specified by:

getPublishDate in interface Comment<T extends CommentCollectionConfiguration>

Returns:

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

getFlagReasons

public java.util.List<FlagReason> getFlagReasons()

Specified by:

getFlagReasons in interface Comment<T extends CommentCollectionConfiguration>

Returns:

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

getCurrentUserFlagText

public java.lang.String getCurrentUserFlagText()

Specified by:

getCurrentUserFlagText in interface Comment<T extends CommentCollectionConfiguration>

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.

getUseFlagReasons

public boolean getUseFlagReasons()

Specified by:

getUseFlagReasons in interface Comment<T extends CommentCollectionConfiguration>

Returns:

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

isFlaggedByUser

public boolean isFlaggedByUser()

Specified by:

isFlaggedByUser in interface Comment<T extends CommentCollectionConfiguration>

Returns:

boolean true if the current user has flagged this content.

getVotes

public SocialComponent getVotes()

Specified by:

getVotes in interface Comment<T extends CommentCollectionConfiguration>

Returns:

voting component

getModeratorActions

public Comment.ModeratorActions getModeratorActions()

Specified by:

getModeratorActions in interface Comment<T extends CommentCollectionConfiguration>

Returns:

the Comment.ModeratorActions

getModeratorStatus

public Comment.ModeratorStatus getModeratorStatus()

This only available if the current user is a moderator.

Specified by:

getModeratorStatus in interface Comment<T extends CommentCollectionConfiguration>

Returns:

the comment moderator status

getParentComponent

public SocialComponent getParentComponent()

Gets the immediate parent of this component.

Specified by:

getParentComponent in interface SocialComponent

Overrides:

getParentComponent in class BaseSocialComponent

Returns:

the parent social component or {code}null{/code} if none exists

getSourceComponent

public SocialComponent getSourceComponent()

Gets the SocialComponent that created this piece of UGC. This generally links back to the component that is in the real content tree.

Specified by:

getSourceComponent in interface SocialComponent

Overrides:

getSourceComponent in class BaseSocialComponent

Returns:

the source social component

getTags

public java.util.List<Comment.Tag> getTags()

Specified by:

getTags in interface Comment<T extends CommentCollectionConfiguration>

getPageInfo

public 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.

Specified by:

getPageInfo in interface Comment<T extends CommentCollectionConfiguration>

Returns:

information about the pagination system

getTranslationDescription

public java.lang.String getTranslationDescription()

Specified by:

getTranslationDescription in interface Comment<T extends CommentCollectionConfiguration>

Returns:

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

getTranslationAttribution

public java.lang.String getTranslationAttribution()

Specified by:

getTranslationAttribution in interface Comment<T extends CommentCollectionConfiguration>

Returns:

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

getTranslationTitle

public java.lang.String getTranslationTitle()

Specified by:

getTranslationTitle in interface Comment<T extends CommentCollectionConfiguration>

Returns:

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

getTranslationDisplay

public java.lang.String getTranslationDisplay()

Specified by:

getTranslationDisplay in interface Comment<T extends CommentCollectionConfiguration>

Returns:

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

getFriendlyUrl

public java.lang.String getFriendlyUrl()

Description copied from interface: SocialComponent

Get a url that can be used to display this component, most of the time, this is the page url that contains the component. This method method may return null value if there is no available friendly url .

Specified by:

getFriendlyUrl in interface SocialComponent

Overrides:

getFriendlyUrl in class BaseSocialComponent

Returns:

friendlyURL String

getReferrerUrl

public java.lang.String getReferrerUrl()

Specified by:

getReferrerUrl in interface Comment<T extends CommentCollectionConfiguration>

Returns:

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