com.adobe.cq.social.review.client.api

Class AbstractReview<C extends CommentCollectionConfiguration>

java.lang.Object

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

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

com.adobe.cq.social.review.client.api.AbstractReview<C>

All Implemented Interfaces:

Comment<C>, ReviewSocialComponent<C>, SocialCollectionComponent, SocialComponent

public class AbstractReview<C extends CommentCollectionConfiguration>
extends AbstractComment<C>
implements ReviewSocialComponent<C>

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
AbstractReview(Resource resource, ClientUtilities clientUtils, CommentSocialComponentListProviderManager listProviderManager) Construct a Review for the specified target resource.
AbstractReview(Resource resource, ClientUtilities clientUtils, QueryRequestInfo queryInfo, CommentSocialComponentListProviderManager listProviderManager) Constructor of a Review.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Long>	getRatingResponses()
VotingSocialComponent	getVoting()
boolean	isCompositeRating() Return true if the review has composite ratings.

Methods inherited from class com.adobe.cq.social.commons.comments.api.AbstractComment

getAttachment, getAttachments, getAuthor, getCanDelete, getCanEdit, getCanReply, getCanTranslate, getConfiguration, getCreated, getCurrentUserFlagText, getFlagReasons, getFriendlyUrl, getItems, getMessage, getModeratorActions, getModeratorStatus, getPageInfo, getParent, getParentComponent, getParentId, getPublishDate, getReferrerUrl, getResourceType, getSourceComponent, getSourceComponentId, getState, getTags, getTotalSize, getTranslationAttribution, getTranslationDescription, getTranslationDisplay, getTranslationTitle, getUseFlagReasons, getVotes, isApproved, isClosed, isDraft, isFeatured, isFlaggedByUser, isPinned, isScheduled, isTopLevel, isUserModerator, isVisible, setPagination, setSortedOrder, setSortFields, 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.commons.comments.api.Comment

getAttachment, getAttachments, getAuthor, getCanDelete, getCanEdit, getCanReply, getCanTranslate, getConfiguration, getCreated, getCurrentUserFlagText, getFlagReasons, getMessage, getModeratorActions, getModeratorStatus, getPageInfo, getParentId, getPublishDate, getReferrerUrl, getSourceComponentId, getState, getTags, getTranslationAttribution, getTranslationDescription, getTranslationDisplay, getTranslationTitle, getUseFlagReasons, getVotes, isApproved, isClosed, isDraft, isFeatured, isFlaggedByUser, isPinned, isScheduled, isTopLevel, isUserModerator, 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, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Constructor Detail

AbstractReview

public AbstractReview(Resource resource,
                      ClientUtilities clientUtils,
                      CommentSocialComponentListProviderManager listProviderManager)
               throws RepositoryException

Construct a Review for the specified target resource.

Parameters:

resource - the specified resource

clientUtils - the client utilities instance

listProviderManager - list manager to use for listing content

Throws:

RepositoryException - if an error occurs

AbstractReview

public AbstractReview(Resource resource,
                      ClientUtilities clientUtils,
                      QueryRequestInfo queryInfo,
                      CommentSocialComponentListProviderManager listProviderManager)
               throws RepositoryException

Constructor of a Review.

Parameters:

resource - the specified Comment

clientUtils - the client utilities instance

queryInfo - the query info.

listProviderManager - list manager to use for listing content

Throws:

RepositoryException - if an error occurs

Method Detail

getRatingResponses

public java.util.Map<java.lang.String,java.lang.Long> getRatingResponses()
                                                                  throws ReviewException

Specified by:

getRatingResponses in interface ReviewSocialComponent<C extends CommentCollectionConfiguration>

Returns:

a map of all rating titles to its user responses.

Throws:

ReviewException

isCompositeRating

public boolean isCompositeRating()

Description copied from interface: ReviewSocialComponent

Return true if the review has composite ratings.

Specified by:

isCompositeRating in interface ReviewSocialComponent<C extends CommentCollectionConfiguration>

Returns:

true if the review has composite ratings.

getVoting

public VotingSocialComponent getVoting()

Specified by:

getVoting in interface ReviewSocialComponent<C extends CommentCollectionConfiguration>

Returns:

return voting for the review.