OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.rules.RaceConstrainerEnablerSearchSession
Implementsosid.voting.rules.RaceConstrainerEnablerQuerySession
Description

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

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

This session defines views that offer differing behaviors for searching.

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

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

MethodgetRaceConstrainerEnablerSearch
Description

Gets a race constrainer enabler search.

Returnosid.voting.rules.RaceConstrainerEnablerSearchthe race constrainer enabler search
CompliancemandatoryThis method must be implemented.
MethodgetRaceConstrainerEnablerSearchOrder
Description

Gets a race constrainer enabler search order. The RaceConstrainerEnablerSearchOrder is supplied to a RaceConstrainerEnablerSearch to specify the ordering of results.

Returnosid.voting.rules.RaceConstrainerEnablerSearchOrderthe race constrainer enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetRaceConstrainerEnablersBySearch
Description

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

Parametersosid.voting.rules.RaceConstrainerEnablerQueryraceConstrainerEnablerQuerythe race constrainer enabler query
osid.voting.rules.RaceConstrainerEnablerSearchraceConstrainerEnablerSearchthe race constrainer enabler search
Returnosid.voting.rules.RaceConstrainerEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT raceConstrainerEnablerQuery or raceConstrainerEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED raceConstrainerEnablerQuery or raceConstrainerEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRaceConstrainerEnablerQueryFromInspector
Description

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

Parametersosid.voting.rules.RaceConstrainerEnablerQueryInspectorraceConstrainerEnablerQueryInspectora race constrainer enabler query inspector
Returnosid.voting.rules.RaceConstrainerEnablerQuerythe race constrainer enabler query
ErrorsNULL_ARGUMENT raceConstrainerEnablerQueryInspector is null
UNSUPPORTED raceConstrainerEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.