OSID Logo
OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.RaceSearch
Implementsosid.OsidSearch
Description

The search interface for governing race searches.

MethodsearchAmongRaces
Description

Execute this search among the given list of races.

Parametersosid.id.IdListraceIdslist of race Ids
ErrorsNULL_ARGUMENT raceIds is null
CompliancemandatoryThis method must be implemented.
MethodorderRaceResults
Description

Specify an ordering to the search results.

Parametersosid.voting.RaceSearchOrderraceSearchOrderrace search order
ErrorsNULL_ARGUMENT raceSearchOrder is null
UNSUPPORTED raceSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRaceSearchRecord
Description

Gets the race search record corresponding to the given race search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TyperaceSearchRecordTypea race search record type
Returnosid.voting.records.RaceSearchRecordthe race search record
ErrorsNULL_ARGUMENT raceSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordTypeType(raceSearchRecordType) is false
CompliancemandatoryThis method must be implemented.