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

Interface ReviewCollectionSocialComponent<C extends ReviewSocialComponent,T extends CommentCollectionConfiguration>

All Superinterfaces:

CommentCollection<C,T>, SocialCollectionComponent, SocialComponent

All Known Implementing Classes:

AbstractReviewCollection

public interface ReviewCollectionSocialComponent<C extends ReviewSocialComponent,T extends CommentCollectionConfiguration>
extends CommentCollection<C,T>

Social Component for any Review resource.

Field Summary

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

DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
List<Map<String,String>>	getAllowedRatings()
Map<String,ResponseValue>	getCurrentUserResponse()
String	getName()
RatingSocialComponent	getOverallRating()
Map<String,String>	getRatingAverages()
Map<String,RatingSocialComponent>	getRatings()
Long	getTotalNumberOfResponses()
boolean	isCompositeRating() Return true if the review has composite ratings.
boolean	isIncludeHistogram() Return true if the review summary includes histogram.

Methods inherited from interface com.adobe.cq.social.commons.comments.api.CommentCollection

getConfiguration, getCreated, getLastModified, getMayPost, getPageInfo, isTaggingAllowed

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

Method Detail

getName

String getName()

Returns:

The name of the review component.

getTotalNumberOfResponses

Long getTotalNumberOfResponses()

Returns:

the total number of responses to this review.

getCurrentUserResponse

Map<String,ResponseValue> getCurrentUserResponse()
                                          throws TallyException,
                                                 RepositoryException

Returns:

a map of the current users response given a session.

Throws:

TallyException - if there was an error retrieving the current users response.

RepositoryException - if there was an error retrieving the current users response.

getRatings

Map<String,RatingSocialComponent> getRatings()

Returns:

a map of all rating titles to the RatingSocialComponent for this review.

getOverallRating

RatingSocialComponent getOverallRating()

Returns:

a RatingSocialComponent for overall rating.

getRatingAverages

Map<String,String> getRatingAverages()

Returns:

a map of all rating titles to rating averages for this review.

getAllowedRatings

List<Map<String,String>> getAllowedRatings()

Returns:

the list of allowed ratings' properties that are designed by the author.

isCompositeRating

boolean isCompositeRating()

Return true if the review has composite ratings.

Returns:

true if the review has composite ratings.

isIncludeHistogram

boolean isIncludeHistogram()

Return true if the review summary includes histogram.

Returns:

true if the review summary includes histogram.