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

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

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

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

MethodgetPollsId
Description

Gets the Polls Id associated with this session.

Returnosid.id.Idthe Polls Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetPolls
Description

Gets the Polls associated with this session.

Returnosid.voting.Pollsthe polls
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchRaceConstrainers
Description

Tests if this user can perform RaceConstrainer lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedPollsView
Description

Federates the view for methods in this session. A federated view will include race constrainer in polls which are children of this race in the polls hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedPollsView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this polls only.

CompliancemandatoryThis method is must be implemented.
MethodgetRaceConstrainerQuery
Description

Gets a race constrainer query.

Returnosid.voting.rules.RaceConstrainerQuerythe race constrainer query
CompliancemandatoryThis method must be implemented.
MethodgetRaceConstrainersByQuery
Description

Gets a list of RaceConstrainers matching the given race constrainer query.

Parametersosid.voting.rules.RaceConstrainerQueryraceConstrainerQuerythe race constrainer query
Returnosid.voting.rules.RaceConstrainerListthe returned RaceConstrainerList
ErrorsNULL_ARGUMENT raceConstrainerQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED raceConstrainerQuery is not of this service
CompliancemandatoryThis method must be implemented.