com.adobe.cq.social.tally

Interface Poll

All Superinterfaces:

Tally<PollResponse>

public interface Poll
extends Tally<PollResponse>

An implementation of tally that manages and keeps track of polls.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TITLE
static String	RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
List<PollResponse>	getAllowedResponses()
Calendar	getCloseDate()
Calendar	getCreateDate()
String	getDescription()
String	getId()
Long	getPollResultForResponse(String response)
Map<PollResponse,Long>	getPollResults()
String	getPollURL()
String	getTitle()
boolean	isClosed()
boolean	isMultipleChoice()
boolean	isOtherAllowed()

Methods inherited from interface com.adobe.cq.social.tally.Tally

canUserRespond, canUserRespond, getCurrentUserResponse, getName, getResponses, getResponses, getResponseTallies, getTallyTarget, getTotalNumberOfResponses, getUseReferrerUrl, getUserResponse, setTallyResourceType, setUserResponse, setUserResponse, unsetUserResponse

Field Detail

RESOURCE_TYPE

static final String RESOURCE_TYPE

See Also:

Constant Field Values

DEFAULT_TITLE

static final String DEFAULT_TITLE

See Also:

Constant Field Values

Method Detail

getTitle

String getTitle()

Returns:

the title of the poll.

getAllowedResponses

List<PollResponse> getAllowedResponses()

Returns:

the list of allowed responses as specified by the author of the poll.

isMultipleChoice

boolean isMultipleChoice()

Returns:

true if a user can select multiple responses to the poll, false otherwise.

isOtherAllowed

boolean isOtherAllowed()

Returns:

true if a user is allowed to enter 'other' responses other than the allowed responses, false otherwise.

getDescription

String getDescription()

Returns:

the description of the poll.

isClosed

boolean isClosed()

Returns:

true if the poll is currently closed, false otherwise.

getCloseDate

Calendar getCloseDate()

Returns:

the date on which this poll closes as specified by the author of the poll. Returns null if no close date is specified.

getCreateDate

Calendar getCreateDate()

Returns:

the date on which this poll was created.

getPollURL

String getPollURL()

Returns:

the URL to which poll responses should be posted to.

getPollResultForResponse

Long getPollResultForResponse(String response)

Parameters:

response - the string value for which the number of votes is requested for.

Returns:

the number of votes that was received by the response.

getPollResults

Map<PollResponse,Long> getPollResults()

Returns:

a map of all PollResponses and the number of votes for each.

getId

String getId()

Returns:

an identifier for this poll.