OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.rules.RaceConstrainerEnablerQuery
Implementsosid.OsidEnablerQuery
Description

This is the query for searching race constrainer enablers. Each method match specifies a AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRuledRaceConstrainerId
Description

Matches enablers mapped to the race constrainer.

Parametersosid.id.IdraceConstrainerIdthe race constrainer Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT raceConstrainerId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledRaceConstrainerIdTerms
Description

Clears the race constrainer Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledRaceConstrainerQuery
Description

Tests if a RaceConstrainerQuery is available.

Returnboolean true if a race constrainer query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledRaceConstrainerQuery
Description

Gets the query for a race constrainer. Multiple retrievals produce a nested OR term.

Returnosid.voting.rules.RaceConstrainerQuerythe race constrainer query
ErrorsUNIMPLEMENTED supportsRuledRaceConstrainerQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledRaceConstrainerQuery() is true.
MethodmatchAnyRuledRaceConstrainer
Description

Matches enablers mapped to any race constrainer.

Parametersbooleanmatch true for enablers mapped to any race constrainer, false to match enablers mapped to no race constrainers
CompliancemandatoryThis method must be implemented.
MethodclearRuledRaceConstrainerTerms
Description

Clears the race constrainer query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPollsId
Description

Matches enablers mapped to the polls.

Parametersosid.id.IdpollsIdthe polls Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT pollsId is null
CompliancemandatoryThis method must be implemented.
MethodclearPollsIdTerms
Description

Clears the polls Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsPollsQuery
Description

Tests if a PollsQuery is available.

Returnboolean true if a polls query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPollsQuery
Description

Gets the query for a polls. Multiple retrievals produce a nested OR term.

Returnosid.voting.PollsQuerythe polls query
ErrorsUNIMPLEMENTED supportsPollsQuery() is false
ComplianceoptionalThis method must be implemented if supportsPollsQuery() is true.
MethodclearPollsTerms
Description

Clears the polls query terms.

CompliancemandatoryThis method must be implemented.
MethodgetRaceConstrainerEnablerQueryRecord
Description

Gets the race constrainer enabler query record corresponding to the given RaceConstrainerEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TyperaceConstrainerEnablerRecordTypea race constrainer enabler record type
Returnosid.voting.rules.records.RaceConstrainerEnablerQueryRecordthe race constrainer enabler query record
ErrorsNULL_ARGUMENT raceConstrainerEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(raceConstrainerEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.