Interface | osid.voting.RaceSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing race searches. | ||
Method | searchAmongRaces | ||
Description |
Execute this search among the given list of races. | ||
Parameters | osid.id.IdList | raceIds | list of race Ids |
Errors | NULL_ARGUMENT | raceIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderRaceResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.voting.RaceSearchOrder | raceSearchOrder | race search order |
Errors | NULL_ARGUMENT | raceSearchOrder is null | |
UNSUPPORTED | raceSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRaceSearchRecord | ||
Description |
Gets the race search record corresponding to the given
race search record | ||
Parameters | osid.type.Type | raceSearchRecordType | a race search record type |
Return | osid.voting.records.RaceSearchRecord | the race search record | |
Errors | NULL_ARGUMENT | raceSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordTypeType(raceSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |