PollService (Nuxeo ECM Projects 5.9.1-SNAPSHOT API Documentation)

All Known Implementing Classes:

PollServiceImpl
```
public interface PollService
```
Service handling Polls.

Since:

5.4.3

Author:

Thomas Roger

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`.

- Method Detail
  - getPollsContainer
```
DocumentModel getPollsContainer(DocumentModel doc)
```
    Returns the polls container located inside the given doc.
    The container is created if it does not exist.
    
    Parameters:
    doc - the document where to create the container
  - getOpenPolls
```
List<Poll> getOpenPolls(CoreSession session)
```
    Returns all open polls available with the given session.
  - getUnansweredOpenPolls
```
List<Poll> getUnansweredOpenPolls(CoreSession session)
```
    Returns all unanswered open polls available with the given session.
  - hasUserAnswered
```
boolean hasUserAnswered(String username,
                      Poll poll)
```
    Returns true if the user with the given username has already answer the poll, false otherwise.
  - answer
```
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.
  - getResultFor
```
PollResult getResultFor(Poll poll)
```
    Returns the current PollResult for the given poll.
  - openPoll
```
Poll openPoll(Poll poll)
```
    Open the poll. The poll will be available through the getOpenPolls(org.nuxeo.ecm.core.api.CoreSession) method.
    The start date of the poll is set to now.
    
    Returns:
    the updated Poll
  - closePoll
```
Poll closePoll(Poll poll)
```
    Close the poll.
    The end date of the poll is set to now.
    
    Returns:
    the updated Poll
  - updatePollStatus
```
Poll updatePollStatus(Poll poll,
                    Date date)
```
    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.

Interface PollService

Method Summary

Method Detail

getPollsContainer

getOpenPolls

getUnansweredOpenPolls

hasUserAnswered

answer

getResultFor

openPoll

closePoll

updatePollStatus