Interface | osid.voting.RaceSearchSession | ||
---|---|---|---|
Implements | osid.voting.RaceQuerySession | ||
Description |
This session provides methods for searching among races.
The search query is constructed using the This session defines views that offer differing behaviors for searching.
| ||
Method | getRaceSearch | ||
Description |
Gets a race search. | ||
Return | osid.voting.RaceSearch | the race search | |
Compliance | mandatory | This method must be implemented. | |
Method | getRaceSearchOrder | ||
Description |
Gets a race search order. The | ||
Return | osid.voting.RaceSearchOrder | the race search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getRacesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.voting.RaceQuery | raceQuery | the race query |
osid.voting.RaceSearch | raceSearch | the race search | |
Return | osid.voting.RaceSearchResults | the returned race search results | |
Errors | NULL_ARGUMENT | raceQuery or raceSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | raceQuery or raceSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRaceQueryFromInspector | ||
Description |
Gets a race query from an inspector. The inspector is
available from a | ||
Parameters | osid.voting.RaceQueryInspector | raceQueryInspector | a race query inspector |
Return | osid.voting.RaceQuery | the race query | |
Errors | NULL_ARGUMENT | raceQueryInspector is null | |
UNSUPPORTED | raceQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |