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

Class AbstractTally

java.lang.Object

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

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

All Implemented Interfaces:

SocialComponent, TallySocialComponent

Direct Known Subclasses:

AbstractRating, AbstractVoting

public class AbstractTally
extends BaseSocialComponent
implements TallySocialComponent

Field Summary

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
AbstractTally(Resource resource, ClientUtilities clientUtils)

Method Summary

Modifier and Type	Method and Description
void	addResponse(String value) Deprecated.
boolean	getCanUserRespond()
ResponseValue	getCurrentUserResponse()
String	getFriendlyUrl() Get a url that can be used to display this component, most of the time, this is the page url that contains the component.
String	getName()
Map<String,Long>	getResponseTallies()
Long	getTotalNumberOfResponses()
void	removeCurrentUserResponse() Deprecated.

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, getId, getParentComponent, getProperties, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Constructor Detail

AbstractTally

public AbstractTally(Resource resource,
                     ClientUtilities clientUtils)

Method Detail

getName

public String getName()

Specified by:

getName in interface TallySocialComponent

Returns:

The name of the tally component.

getTotalNumberOfResponses

public Long getTotalNumberOfResponses()

Specified by:

getTotalNumberOfResponses in interface TallySocialComponent

Returns:

the total number of responses to this tally.

getCurrentUserResponse

public ResponseValue getCurrentUserResponse()
                                     throws TallyException

Specified by:

getCurrentUserResponse in interface TallySocialComponent

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

Returns:

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

addResponse

@Deprecated
public void addResponse(String value)

Deprecated.

removeCurrentUserResponse

@Deprecated
public void removeCurrentUserResponse()

Deprecated.

getCanUserRespond

public boolean getCanUserRespond()

Specified by:

getCanUserRespond in interface TallySocialComponent

Returns:

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

getFriendlyUrl

public String getFriendlyUrl()

Description copied from interface: SocialComponent

Get a url that can be used to display this component, most of the time, this is the page url that contains the component. This method method may return null value if there is no available friendly url .

Specified by:

getFriendlyUrl in interface SocialComponent

Overrides:

getFriendlyUrl in class BaseSocialComponent