Interface | osid.voting.rules.BallotConstrainerEnablerPollsSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupBallotConstrainerEnablerPollsMappings | ||
Description |
Tests if this user can perform lookups of ballot
constrainer enabler/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 | useComparativeBallotConstrainerEnablerPollsView | ||
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 | usePlenaryBallotConstrainerEnablerPollsView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getBallotConstrainerEnablerIdsByPolls | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | pollsId | Id of the Polls |
Return | osid.id.IdList | list of related ballot constrainer enabler 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 | getBallotConstrainerEnablersByPolls | ||
Description |
Gets the list of ballot constrainer enablers associated
with a | ||
Parameters | osid.id.Id | pollsId | Id of the Polls |
Return | osid.voting.rules.BallotConstrainerEnablerList | list of related ballot constrainer enablers | |
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 | getBallotConstrainerEnablerIdsByPolls | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | pollsIds | list of polls Ids |
Return | osid.id.IdList | list of ballot constrainer enabler 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 | getBallotConstrainerEnablersByPolls | ||
Description |
Gets the list of ballot constrainer enablers
corresponding to a list of | ||
Parameters | osid.id.IdList | pollsIds | list of polls Ids |
Return | osid.voting.rules.BallotConstrainerEnablerList | list of ballot constrainer enablers | |
Errors | NULL_ARGUMENT | pollsIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPollsIdsByBallotConstrainerEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ballotConstrainerEnablerId | Id of a BallotConstrainerEnabler |
Return | osid.id.IdList | list of polls | |
Errors | NOT_FOUND | ballotConstrainerEnablerId is not found | |
NULL_ARGUMENT | ballotConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPollsByBallotConstrainerEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ballotConstrainerEnablerId | Id of a BallotConstrainerEnabler |
Return | osid.voting.PollsList | list of polls | |
Errors | NOT_FOUND | ballotConstrainerEnablerId is not found | |
NULL_ARGUMENT | ballotConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |