OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.rules.RaceConstrainerSearchSession
Implementsosid.voting.rules.RaceConstrainerQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetRaceConstrainerSearch
Description

Gets a race constrainer search.

Returnosid.voting.rules.RaceConstrainerSearchthe race constrainer search
CompliancemandatoryThis method must be implemented.
MethodgetRaceConstrainerSearchOrder
Description

Gets a race constrainer search order. The RaceConstrainerSearchOrder is supplied to a RaceConstrainerSearch to specify the ordering of results.

Returnosid.voting.rules.RaceConstrainerSearchOrderthe race constrainer search order
CompliancemandatoryThis method must be implemented.
MethodgetRaceConstrainersBySearch
Description

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

Parametersosid.voting.rules.RaceConstrainerQueryraceConstrainerQuerythe race constrainer query
osid.voting.rules.RaceConstrainerSearchraceConstrainerSearchthe race constrainer search
Returnosid.voting.rules.RaceConstrainerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT raceConstrainerQuery or raceConstrainerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED raceConstrainerQuery or raceConstrainerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRaceConstrainerQueryFromInspector
Description

Gets a race constrainer query from an inspector. The inspector is available from a RaceConstrainerSearchResults.

Parametersosid.voting.rules.RaceConstrainerQueryInspectorraceConstrainerQueryInspectora race constrainer query inspector
Returnosid.voting.rules.RaceConstrainerQuerythe race constrainer query
ErrorsNULL_ARGUMENT raceConstrainerQueryInspector is null
UNSUPPORTED raceConstrainerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.