com.adobe.cq.social.tally

Interface Tally<T extends ResponseValue>

Type Parameters:

T - The response value object that a tally will keep track of

All Known Subinterfaces:

Liking, Poll, RatingComponent, Voting

public interface Tally<T extends ResponseValue>

A tally is a resource that can keep count or tally of a set of user responses on a specific target resource.

Method Summary

Modifier and Type	Method and Description
boolean	canUserRespond() checks if the current logged in user has privileges to respond to this tally (based on ACLs).
boolean	canUserRespond(SlingHttpServletRequest request) checks if the current logged in user has privileges to respond to this tally (based on ACLs).
T	getCurrentUserResponse()
java.lang.String	getName()
java.util.Iterator<Response<T>>	getResponses(java.lang.Long start)
java.util.Iterator<Response<T>>	getResponses(java.lang.Long start, int numberOfResponses)
java.util.Map<T,java.lang.Long>	getResponseTallies()
Resource	getTallyTarget()
java.lang.Long	getTotalNumberOfResponses()
boolean	getUseReferrerUrl() Check if the tally is using referrerUrl for its AbstractTally.getFriendlyUrl() or not.
Response<T>	getUserResponse(java.lang.String userId)
void	setTallyResourceType(java.lang.String resourceType)
Resource	setUserResponse(java.lang.String userId, java.lang.String responseValue) sets the user response for this tally in jcr.
Resource	setUserResponse(java.lang.String userId, java.lang.String responseValue, java.util.Map<java.lang.String,java.lang.Object> additionalPoperties) sets the user response for this tally in jcr.
Resource	unsetUserResponse(java.lang.String userId) unsets the user response in jcr.

Method Detail

getName

java.lang.String getName()

Returns:

the name of this tally

getTotalNumberOfResponses

java.lang.Long getTotalNumberOfResponses()

Returns:

count of number of users who responded to this tally

getUserResponse

Response<T> getUserResponse(java.lang.String userId)
                     throws TallyException,
                            RepositoryException

Parameters:

userId - the user for whom the response is requested for

Returns:

the response of the current user. null if the user has not responded

Throws:

TallyException - when there was an error in reading the users latest response

RepositoryException - when there is a JCR error in reading the users latest response

getCurrentUserResponse

T getCurrentUserResponse()
                  throws TallyException

Returns:

the response of the current user. null if the user has not responded

Throws:

TallyException - when there was an error in reading the users latest response

getResponses

java.util.Iterator<Response<T>> getResponses(java.lang.Long start,
                                             int numberOfResponses)

Parameters:

start - the beginning index which to return the responses from

numberOfResponses - the number of responses to be returned

Returns:

a list of responses

getResponses

java.util.Iterator<Response<T>> getResponses(java.lang.Long start)

Parameters:

start - the beginning index which to return the responses from

Returns:

a list of responses

getResponseTallies

java.util.Map<T,java.lang.Long> getResponseTallies()

Returns:

a map of each response value to the count of number of users who have chosen the value. Example: [Helpful -> 4, Unhelpful ->5], [5-stars -> 3, 4-stars -> 2, 1-star -> 4]

getTallyTarget

Resource getTallyTarget()

Returns:

the resource for which this tally is being maintained

setUserResponse

Resource setUserResponse(java.lang.String userId,
                         java.lang.String responseValue)
                  throws TallyException,
                         RepositoryException

sets the user response for this tally in jcr.

Parameters:

userId - the authorizable id of the user who responded to the tally

responseValue - the response value entered by the user for the tally

Returns:

the Resource object representing the response

Throws:

TallyException - when there is an error in setting the user response

RepositoryException - when there is a JCR error in setting the user response

setUserResponse

Resource setUserResponse(java.lang.String userId,
                         java.lang.String responseValue,
                         java.util.Map<java.lang.String,java.lang.Object> additionalPoperties)
                  throws TallyException,
                         RepositoryException

sets the user response for this tally in jcr.

Parameters:

userId - the authorizable id of the user who responded to the tally

responseValue - the response value entered by the user for the tally

additionalPoperties - any additional properties to write to the resource; may be null

Returns:

the Resource object representing the response

Throws:

TallyException - when there is an error in setting the user response

RepositoryException - when there is a JCR error in setting the user response

unsetUserResponse

Resource unsetUserResponse(java.lang.String userId)
                    throws TallyException,
                           RepositoryException

unsets the user response in jcr. Theoretically, this is like deleting the user response

Parameters:

userId - the authorizable id of the user who responded to the tally

Returns:

the Resource object representing the node that indicates an unset response

Throws:

TallyException - when there is an error in trying to unset the user response

RepositoryException - when there is a JCR error in setting the user response

canUserRespond

boolean canUserRespond()

checks if the current logged in user has privileges to respond to this tally (based on ACLs).

Returns:

true if user has privileges, false otherwise or if no user is logged in

canUserRespond

boolean canUserRespond(SlingHttpServletRequest request)

checks if the current logged in user has privileges to respond to this tally (based on ACLs). This can track the client context.

Parameters:

request - the sling request to use as the basis of the user determination

Returns:

true if user has privileges, false otherwise or if no user is logged in

setTallyResourceType

void setTallyResourceType(java.lang.String resourceType)

Parameters:

resourceType - - the resource type to use when creating tally component resource nodes if needed in ugc.

getUseReferrerUrl

boolean getUseReferrerUrl()

Check if the tally is using referrerUrl for its AbstractTally.getFriendlyUrl() or not.

Returns: