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 String	RATING_RESOURCE_TYPE

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
Float	getAverageRating()
String	getFormattedAverageRating()
List<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, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Field Detail

RATING_RESOURCE_TYPE

static final String RATING_RESOURCE_TYPE

See Also:

Constant Field Values

Method Detail

getAverageRating

Float getAverageRating()

Returns:

the average rating

getFormattedAverageRating

String getFormattedAverageRating()

Returns:

the formatted average rating in String

getRatingResults

List<String[]> getRatingResults()

Returns:

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