com.adobe.cq.social.tally.client.endpoints

Interface TallyOperationsService

public interface TallyOperationsService

A service that performs operations on a tally component.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LIKING Tally type string for Liking.
static java.lang.String	POLL Tally type string for Polls.
static java.lang.String	RATING Tally type string for Rating.
static java.lang.String	VOTING Tally type string for Voting.

Method Summary

Modifier and Type	Method and Description
Resource	addCurrentUserResponseResponse(Resource tallyResource, java.lang.String responseValue, java.lang.String tallyType) Sets the response for the current user.
void	removeCurrentUserResponse(Resource tallyResource, java.lang.String tallyType)
Resource	setResponse(SlingHttpServletRequest request)
Resource	setTallyResponse(Resource tally, java.lang.String author, Session session, java.lang.String tallyResponse, java.lang.String tallyType, java.util.Map<java.lang.String,java.lang.Object> parameters) Allows setting a tally response for an arbitrary user of caller's choice.

Field Detail

RATING

static final java.lang.String RATING

Tally type string for Rating.

See Also:

Constant Field Values

VOTING

static final java.lang.String VOTING

Tally type string for Voting.

See Also:

Constant Field Values

POLL

static final java.lang.String POLL

Tally type string for Polls.

See Also:

Constant Field Values

LIKING

static final java.lang.String LIKING

Tally type string for Liking.

See Also:

Constant Field Values

Method Detail

addCurrentUserResponseResponse

Resource addCurrentUserResponseResponse(Resource tallyResource,
                                        java.lang.String responseValue,
                                        java.lang.String tallyType)
                                 throws OperationException

Sets the response for the current user. Current user is figured out from the session using which the resource was obtained.

Parameters:

tallyResource - the tally resource on which the response is added.

responseValue - the response value to set.

Returns:

the response resource.

Throws:

OperationException - when an error occurs.

removeCurrentUserResponse

void removeCurrentUserResponse(Resource tallyResource,
                               java.lang.String tallyType)
                        throws OperationException

Parameters:

tallyResource - the tally resource on which the response is added.

Throws:

OperationException - when an error occurs.

setResponse

Resource setResponse(SlingHttpServletRequest request)
              throws OperationException

Parameters:

request - the request that triggered this operation.

Returns:

the response resource.

Throws:

OperationException - if an error occurs.

setTallyResponse

Resource setTallyResponse(Resource tally,
                          java.lang.String author,
                          Session session,
                          java.lang.String tallyResponse,
                          java.lang.String tallyType,
                          java.util.Map<java.lang.String,java.lang.Object> parameters)
                   throws OperationException

Allows setting a tally response for an arbitrary user of caller's choice. Needed this method made public for migrating tally content.

Parameters:

tally -

author -

session -

tallyResponse -

tallyType -

parameters -

Returns:

Throws:

OperationException