OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.rules.RaceProcessorSearchSession
Implementsosid.voting.rules.RaceProcessorQuerySession
Description

This session provides methods for searching among RaceProcessor objects. The search query is constructed using the RaceProcessoryQuery.

getRaceProcessorsByQuery() is the basic search method and returns a list of RaceProcessors. A more advanced search may be performed with getRaceProcessorsBySearch(). It accepts a RaceProcessorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as voting. getRaceProcessorsBySearch() returns a RaceProcessorSearchResults that can be used to access the resulting RaceProcessorList or be used to perform a search within the result set through RaceProcessorSearch.

This session defines views that offer differing behaviors for searching.

  • federated polls view: searches include race processor in polls of which this polls is an ancestor in the polls hierarchy
  • isolated polls view: searches are restricted to race processor in this polls

RaceProcessors may have a query record indicated by their respective record types. Thequery record is accessed via the RaceProcessorQuery.

MethodgetRaceProcessorSearch
Description

Gets a race processor search.

Returnosid.voting.rules.RaceProcessorSearchthe race processor search
CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessorSearchOrder
Description

Gets a race processor search order. The RaceProcessorSearchOrder is supplied to a RaceProcessorSearch to specify the ordering of results.

Returnosid.voting.rules.RaceProcessorSearchOrderthe race processor search order
CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessorsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.voting.rules.RaceProcessorQueryraceProcessorQuerythe race processor query
osid.voting.rules.RaceProcessorSearchraceProcessorSearchthe race processor search
Returnosid.voting.rules.RaceProcessorSearchResultsthe returned search results
ErrorsNULL_ARGUMENT raceProcessorQuery or raceProcessorSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED raceProcessorQuery or raceProcessorSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessorQueryFromInspector
Description

Gets a race processor query from an inspector. The inspector is available from a RaceProcessorSearchResults.

Parametersosid.voting.rules.RaceProcessorQueryInspectorraceProcessorQueryInspectora race processor query inspector
Returnosid.voting.rules.RaceProcessorQuerythe race processor query
ErrorsNULL_ARGUMENT raceProcessorQueryInspector is null
UNSUPPORTED raceProcessorQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.