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

Interface VotingSocialComponent

All Superinterfaces:

SocialComponent, TallySocialComponent

All Known Implementing Classes:

AbstractVoting

public interface VotingSocialComponent
extends TallySocialComponent

SocialComponent for Voting.

Field Summary

Fields

Modifier and Type	Field and Description
static String	VOTING_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
long	getNegativeCount()
String	getNegativeLabel()
long	getNetCount()
long	getPositiveCount()
String	getPositiveLabel()
boolean	isCurrentUserLike()

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

VOTING_RESOURCE_TYPE

static final String VOTING_RESOURCE_TYPE

See Also:

Constant Field Values

Method Detail

getNetCount

long getNetCount()

Returns:

the net vote count, number of positive votes minus number of negative votes.

getPositiveCount

long getPositiveCount()

Returns:

the number of positive votes.

getNegativeCount

long getNegativeCount()

Returns:

the number of negative votes.

getPositiveLabel

String getPositiveLabel()

Returns:

the label for the positive response

getNegativeLabel

String getNegativeLabel()

Returns:

the label for the negative response

isCurrentUserLike

boolean isCurrentUserLike()

Returns:

true if current user vote is postive, false if current user vote is negative or if current user has not voted.