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

Class AbstractRating

java.lang.Object

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

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

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

All Implemented Interfaces:

SocialComponent, RatingSocialComponent, TallySocialComponent

public abstract class AbstractRating
extends AbstractTally
implements RatingSocialComponent

Field Summary

Fields inherited from interface com.adobe.cq.social.tally.client.api.RatingSocialComponent

RATING_RESOURCE_TYPE

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

DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Constructor Summary

Constructors

Constructor and Description
AbstractRating(Resource resource)
AbstractRating(Resource resource, ClientUtilities clientUtils)

Method Summary

Modifier and Type	Method and Description
void	addResponse(String value)
Float	getAverageRating()
boolean	getCanUserRespond()
ResponseValue	getCurrentUserResponse()
String	getFormattedAverageRating()
String	getName()
List<String[]>	getRatingResults()
Map<String,Long>	getResponseTallies()
Long	getTotalNumberOfResponses()
void	removeCurrentUserResponse()

Methods inherited from class com.adobe.cq.social.tally.client.api.AbstractTally

getFriendlyUrl

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

buildJSONString, getAsMap, getId, getParentComponent, getProperties, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

AbstractRating

public AbstractRating(Resource resource)

AbstractRating

public AbstractRating(Resource resource,
                      ClientUtilities clientUtils)

Method Detail

getName

public String getName()

Specified by:

getName in interface TallySocialComponent

Overrides:

getName in class AbstractTally

Returns:

The name of the tally component.

getTotalNumberOfResponses

public Long getTotalNumberOfResponses()

Specified by:

getTotalNumberOfResponses in interface TallySocialComponent

Overrides:

getTotalNumberOfResponses in class AbstractTally

Returns:

the total number of responses to this tally.

getCurrentUserResponse

public ResponseValue getCurrentUserResponse()
                                     throws TallyException

Specified by:

getCurrentUserResponse in interface TallySocialComponent

Overrides:

getCurrentUserResponse in class AbstractTally

Returns:

the current users response given a session.

Throws:

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

getResponseTallies

public Map<String,Long> getResponseTallies()

Specified by:

getResponseTallies in interface TallySocialComponent

Overrides:

getResponseTallies in class AbstractTally

Returns:

a map of all responses to number of users who have chosen the response.

addResponse

public void addResponse(String value)

Overrides:

addResponse in class AbstractTally

removeCurrentUserResponse

public void removeCurrentUserResponse()

Overrides:

removeCurrentUserResponse in class AbstractTally

getAverageRating

public Float getAverageRating()

Specified by:

getAverageRating in interface RatingSocialComponent

Returns:

the average rating

getFormattedAverageRating

public String getFormattedAverageRating()

Specified by:

getFormattedAverageRating in interface RatingSocialComponent

Returns:

the formatted average rating in String

getRatingResults

public List<String[]> getRatingResults()

Specified by:

getRatingResults in interface RatingSocialComponent

Returns:

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

getCanUserRespond

public boolean getCanUserRespond()

Specified by:

getCanUserRespond in interface TallySocialComponent

Overrides:

getCanUserRespond in class AbstractTally

Returns:

true if the logged in user can respond to the tally, false otherwise.