OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.rules.RaceProcessorEnablerSearchSession
Implementsosid.voting.rules.RaceProcessorEnablerQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

RaceProcessorEnablers may have a query record indicated by their respective query record types. The record is accessed via the RaceProcessorEnablerQuery.

MethodgetRaceProcessorEnablerSearch
Description

Gets a race processor enabler search.

Returnosid.voting.rules.RaceProcessorEnablerSearchthe race processor enabler search
CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessorEnablerSearchOrder
Description

Gets a race processor enabler search order. The RaceProcessorEnablerSearchOrder is supplied to a RaceProcessorEnablerSearch to specify the ordering of results.

Returnosid.voting.rules.RaceProcessorEnablerSearchOrderthe race processor enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessorEnablersBySearch
Description

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

Parametersosid.voting.rules.RaceProcessorEnablerQueryraceProcessorEnablerQuerythe race processor enabler query
osid.voting.rules.RaceProcessorEnablerSearchraceProcessorEnablerSearchthe race processor enabler search
Returnosid.voting.rules.RaceProcessorEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT raceProcessorEnablerQuery or raceProcessorEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED raceProcessorEnablerQuery or raceProcessorEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRaceProcessorEnablerQueryFromInspector
Description

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

Parametersosid.voting.rules.RaceProcessorEnablerQueryInspectorraceProcessorEnablerQueryInspectora race processor enabler query inspector
Returnosid.voting.rules.RaceProcessorEnablerQuerythe race processor enabler query
ErrorsNULL_ARGUMENT raceProcessorEnablerQueryInspector is null
UNSUPPORTED raceProcessorEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.