com.adobe.cq.social.tally.client.api

Interface RatingSocialComponent

All Superinterfaces:

SocialComponent, TallySocialComponent

All Known Implementing Classes:

AbstractRating

public interface RatingSocialComponent
extends TallySocialComponent

SocialComponent for Ratings.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RATING_RESOURCE_TYPE

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
java.lang.Float	getAverageRating()
java.lang.String	getFormattedAverageRating()
java.util.List<java.lang.String[]>	getRatingResults()

Methods inherited from interface com.adobe.cq.social.tally.client.api.TallySocialComponent

getCanUserRespond, getCurrentUserResponse, getName, getResponseTallies, getTotalNumberOfResponses

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

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

Field Detail

RATING_RESOURCE_TYPE

static final java.lang.String RATING_RESOURCE_TYPE

See Also:

Constant Field Values

Method Detail

getAverageRating

java.lang.Float getAverageRating()

Returns:

the average rating

getFormattedAverageRating

java.lang.String getFormattedAverageRating()

Returns:

the formatted average rating in String

getRatingResults

java.util.List<java.lang.String[]> getRatingResults()

Returns:

a map of all Responses and the number of votes and percentage of votes for each.