Interface | osid.voting.rules.RaceProcessorPollsSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupRaceProcessorPollsMappings | ||
Description |
Tests if this user can perform lookups of race
processor/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 | useComparativeRaceProcessorPollsView | ||
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 | usePlenaryRaceProcessorPollsView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getRaceProcessorIdsByPolls | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | pollsId | Id of the Polls |
Return | osid.id.IdList | list of related race processor 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 | getRaceProcessorsByPolls | ||
Description |
Gets the list of race processors associated with a
| ||
Parameters | osid.id.Id | pollsId | Id of the Polls |
Return | osid.voting.rules.RaceProcessorList | list of related race processors | |
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 | getRaceProcessorIdsByPolls | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | pollsIds | list of polls Ids |
Return | osid.id.IdList | list of race processor 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 | getRaceProcessorsByPolls | ||
Description |
Gets the list of race processor corresponding to a list
of | ||
Parameters | osid.id.IdList | pollsIds | list of polls Ids |
Return | osid.voting.rules.RaceProcessorList | list of race processors | |
Errors | NULL_ARGUMENT | pollsIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPollsIdsByRaceProcessor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | raceProcessorId | Id of a RaceProcessor |
Return | osid.id.IdList | list of polls | |
Errors | NOT_FOUND | raceProcessorId is not found | |
NULL_ARGUMENT | raceProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPollsByRaceProcessor | ||
Description |
Gets the | ||
Parameters | osid.id.Id | raceProcessorId | Id of a RaceProcessor |
Return | osid.voting.PollsList | list of polls | |
Errors | NOT_FOUND | raceProcessorId is not found | |
NULL_ARGUMENT | raceProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |