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

Interface TallySocialComponent

All Superinterfaces:

SocialComponent

All Known Subinterfaces:

RatingSocialComponent, VotingSocialComponent

All Known Implementing Classes:

AbstractRating, AbstractTally, AbstractVoting

public interface TallySocialComponent
extends SocialComponent

Social Component for any Tally 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
boolean	getCanUserRespond()
ResponseValue	getCurrentUserResponse()
String	getName()
Map<String,Long>	getResponseTallies()
Long	getTotalNumberOfResponses()

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 tally component.

getTotalNumberOfResponses

Long getTotalNumberOfResponses()

Returns:

the total number of responses to this tally.

getCurrentUserResponse

ResponseValue getCurrentUserResponse()
                              throws TallyException

Returns:

the current users response given a session.

Throws:

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

getResponseTallies

Map<String,Long> getResponseTallies()

Returns:

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

getCanUserRespond

boolean getCanUserRespond()

Returns:

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