Interface | osid.voting.rules.RaceProcessorEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching race processor enablers.
Each method match specifies a | ||
Method | matchRuledRaceProcessorId | ||
Description |
Matches enablers mapped to the race processor. | ||
Parameters | osid.id.Id | raceProcessorId | the race processor Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | raceProcessorId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledRaceProcessorIdTerms | ||
Description |
Clears the race processor | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledRaceProcessorQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a race processor query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledRaceProcessorQuery | ||
Description |
Gets the query for a race processor. Multiple
retrievals produce a nested | ||
Return | osid.voting.rules.RaceProcessorQuery | the race processor query | |
Errors | UNIMPLEMENTED | supportsRuledRaceProcessorQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledRaceProcessorQuery()
is true. | |
Method | matchAnyRuledRaceProcessor | ||
Description |
Matches enablers mapped to any race processor. | ||
Parameters | boolean | match | true for enablers mapped to any race processor, false
to match enablers mapped to no race processors |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledRaceProcessorTerms | ||
Description |
Clears the race processor query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchPollsId | ||
Description |
Matches enablers mapped to the polls. | ||
Parameters | osid.id.Id | pollsId | the polls Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | pollsId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearPollsIdTerms | ||
Description |
Clears the polls | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsPollsQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a polls query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPollsQuery | ||
Description |
Gets the query for a polls. Multiple retrievals produce
a nested | ||
Return | osid.voting.PollsQuery | the polls query | |
Errors | UNIMPLEMENTED | supportsPollsQuery() is false | |
Compliance | optional | This method must be implemented if supportsPollsQuery() is
true. | |
Method | clearPollsTerms | ||
Description |
Clears the polls query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRaceProcessorEnablerQueryRecord | ||
Description |
Gets the race processor enabler query record
corresponding to the given | ||
Parameters | osid.type.Type | raceProcessorEnablerRecordType | a race processor enabler record type |
Return | osid.voting.rules.records.RaceProcessorEnablerQueryRecord | the race processor enabler query record | |
Errors | NULL_ARGUMENT | raceProcessorEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(raceProcessorEnablerRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |