org.nuxeo.ecm.poll

Class PollServiceImpl

java.lang.Object

org.nuxeo.ecm.poll.PollServiceImpl

All Implemented Interfaces:

PollService

public class PollServiceImpl
extends Object
implements PollService

Default implementation of PollService.

Since:

5.4.3

Author:

Thomas Roger

Field Summary

Fields

Modifier and Type	Field and Description
static String	SURVEYS_CONTAINER_NAME

Constructor Summary

Constructors

Constructor and Description
PollServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	answer(String username, Poll poll, int answerIndex) Store that the user with the given @{code username} has answered the poll with the answer number answerIndex.
Poll	closePoll(Poll poll) Close the poll.
List<Poll>	getOpenPolls(CoreSession session) Returns all open polls available with the given session.
DocumentModel	getPollsContainer(DocumentModel doc) Returns the polls container located inside the given doc.
PollResult	getResultFor(Poll poll) Returns the current PollResult for the given poll.
List<Poll>	getUnansweredOpenPolls(CoreSession session) Returns all unanswered open polls available with the given session.
boolean	hasUserAnswered(String username, Poll poll) Returns true if the user with the given username has already answer the poll, false otherwise.
Poll	openPoll(Poll poll) Open the poll.
Poll	updatePollStatus(Poll poll, Date date) Update the status of the poll according to the given date.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SURVEYS_CONTAINER_NAME

public static final String SURVEYS_CONTAINER_NAME

See Also:

Constant Field Values

Constructor Detail

PollServiceImpl

public PollServiceImpl()

Method Detail

getPollsContainer

public DocumentModel getPollsContainer(DocumentModel doc)

Description copied from interface: PollService

Returns the polls container located inside the given doc.

The container is created if it does not exist.

Specified by:

getPollsContainer in interface PollService

Parameters:

doc - the document where to create the container

getOpenPolls

public List<Poll> getOpenPolls(CoreSession session)

Description copied from interface: PollService

Returns all open polls available with the given session.

Specified by:

getOpenPolls in interface PollService

getUnansweredOpenPolls

public List<Poll> getUnansweredOpenPolls(CoreSession session)

Description copied from interface: PollService

Returns all unanswered open polls available with the given session.

Specified by:

getUnansweredOpenPolls in interface PollService

hasUserAnswered

public boolean hasUserAnswered(String username,
                      Poll poll)

Description copied from interface: PollService

Returns true if the user with the given username has already answer the poll, false otherwise.

Specified by:

hasUserAnswered in interface PollService

answer

public void answer(String username,
          Poll poll,
          int answerIndex)

Description copied from interface: PollService

Store that the user with the given @{code username} has answered the poll with the answer number answerIndex.

Specified by:

answer in interface PollService

getResultFor

public PollResult getResultFor(Poll poll)

Description copied from interface: PollService

Returns the current PollResult for the given poll.

Specified by:

getResultFor in interface PollService

openPoll

public Poll openPoll(Poll poll)

Description copied from interface: PollService

Open the poll. The poll will be available through the PollService.getOpenPolls(org.nuxeo.ecm.core.api.CoreSession) method.

The start date of the poll is set to now.

Specified by:

openPoll in interface PollService

Returns:

the updated Poll

closePoll

public Poll closePoll(Poll poll)

Description copied from interface: PollService

Close the poll.

The end date of the poll is set to now.

Specified by:

closePoll in interface PollService

Returns:

the updated Poll

updatePollStatus

public Poll updatePollStatus(Poll poll,
                    Date date)

Description copied from interface: PollService

Update the status of the poll according to the given date.

The poll can be open or closed according to its start date and end date.

Specified by:

updatePollStatus in interface PollService