Interface | osid.voting.RaceSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getRaces | ||
Description |
Gets the race list resulting from a search. | ||
Return | osid.voting.RaceList | the race list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getRaceQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.voting.RaceQueryInspector | the race query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getRaceSearchResultsRecord | ||
Description |
Gets the race search results record corresponding to
the given race search record | ||
Parameters | osid.type.Type | raceSearchRecordType | a race search record type |
Return | osid.voting.records.RaceSearchResultsRecord | the race search results 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. |