Interface | osid.voting.rules.RaceProcessorSmartPollsSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic polls. a This | ||
Method | getPollsId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Polls Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getPolls | ||
Description |
Gets the | ||
Return | osid.voting.Polls | the polls | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartPolls | ||
Description |
Tests if this user can manage smart polls. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart polls management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRaceProcessorQuery | ||
Description |
Gets a race processor query. | ||
Return | osid.voting.rules.RaceProcessorQuery | the race processor query | |
Compliance | mandatory | This method must be implemented. | |
Method | getRaceProcessorSearchOrder | ||
Description |
Gets a race processor search order. | ||
Return | osid.voting.rules.RaceProcessorSearchOrder | the race processor search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyRaceProcessorQuery | ||
Description |
Applies a race processor query to this polls. | ||
Parameters | osid.voting.rules.RaceProcessorQuery | raceProcessorQuery | the race processor query |
Errors | NULL_ARGUMENT | raceProcessorQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | raceProcessorQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectRaceProcessorQuery | ||
Description |
Gets a race processor query inspector for this polls. | ||
Return | osid.voting.rules.RaceProcessorQueryInspector | the race processor query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyRaceProcessorSequencing | ||
Description |
Applies a race processor search order to this polls. | ||
Parameters | osid.voting.rules.RaceProcessorSearchOrder | raceProcessorSearchOrder | the race processor search order |
Errors | NULL_ARGUMENT | raceProcessorSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | raceProcessorSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRaceProcessorQueryFromInspector | ||
Description |
Gets a race processor query from an inspector. | ||
Parameters | osid.voting.rules.RaceProcessorQueryInspector | raceProcessorQueryInspector | a race processor query inspector |
Return | osid.voting.rules.RaceProcessorQuery | the race processor query | |
Errors | NULL_ARGUMENT | raceProcessorQueryInspector is null | |
UNSUPPORTED | raceProcessorQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |