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

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

MethodmatchRuledRaceProcessorId
Description

Matches enablers mapped to the race processor.

Parametersosid.id.IdraceProcessorIdthe race processor Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT raceProcessorId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledRaceProcessorIdTerms
Description

Clears the race processor Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledRaceProcessorQuery
Description

Tests if a RaceProcessorQuery is available.

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

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

Returnosid.voting.rules.RaceProcessorQuerythe race processor query
ErrorsUNIMPLEMENTED supportsRuledRaceProcessorQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledRaceProcessorQuery() is true.
MethodmatchAnyRuledRaceProcessor
Description

Matches enablers mapped to any race processor.

Parametersbooleanmatch true for enablers mapped to any race processor, false to match enablers mapped to no race processors
CompliancemandatoryThis method must be implemented.
MethodclearRuledRaceProcessorTerms
Description

Clears the race processor 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.
MethodgetRaceProcessorEnablerQueryRecord
Description

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

Parametersosid.type.TyperaceProcessorEnablerRecordTypea race processor enabler record type
Returnosid.voting.rules.records.RaceProcessorEnablerQueryRecordthe race processor enabler query record
ErrorsNULL_ARGUMENT raceProcessorEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(raceProcessorEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.