Interface | osid.voting.BallotPollsSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | useComparativePollsView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryPollsView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | canLookupBallotPollsMappings | ||
Description |
Tests if this user can perform lookups of ballot/polls
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known lookup methods in this session will result in a
| ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getBallotIdsByPolls | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | pollsId | Id of a Polls |
Return | osid.id.IdList | list of related ballot Ids | |
Errors | NOT_FOUND | pollsId is not found | |
NULL_ARGUMENT | pollsId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBallotsByPolls | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | pollsId | Id of a Polls |
Return | osid.voting.BallotList | list of related ballots | |
Errors | NOT_FOUND | pollsId is not found | |
NULL_ARGUMENT | pollsId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBallotIdsByPolls | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | pollsIds | list of polls Ids |
Return | osid.id.IdList | list of ballot Ids | |
Errors | NULL_ARGUMENT | pollsIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBallotsByPolls | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | pollsIds | list of polls Ids |
Return | osid.voting.BallotList | list of ballots | |
Errors | NULL_ARGUMENT | pollsIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPollsIdsByBallot | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | ballotId | Id of a Ballot |
Return | osid.id.IdList | list of polls Ids | |
Errors | NOT_FOUND | ballotId is not found | |
NULL_ARGUMENT | ballotId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPollsByBallot | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | ballotId | Id of a Ballot |
Return | osid.voting.PollsList | list of polls | |
Errors | NOT_FOUND | ballotId is not found | |
NULL_ARGUMENT | ballotId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |