Interface | osid.voting.rules.RaceConstrainerEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching race constrainer enablers.
Each method match specifies a | ||
Method | matchRuledRaceConstrainerId | ||
Description |
Matches enablers mapped to the race constrainer. | ||
Parameters | osid.id.Id | raceConstrainerId | the race constrainer Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | raceConstrainerId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledRaceConstrainerIdTerms | ||
Description |
Clears the race constrainer | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledRaceConstrainerQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a race constrainer query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledRaceConstrainerQuery | ||
Description |
Gets the query for a race constrainer. Multiple
retrievals produce a nested | ||
Return | osid.voting.rules.RaceConstrainerQuery | the race constrainer query | |
Errors | UNIMPLEMENTED | supportsRuledRaceConstrainerQuery() is false | |
Compliance | optional | This method must be implemented if
supportsRuledRaceConstrainerQuery() is true. | |
Method | matchAnyRuledRaceConstrainer | ||
Description |
Matches enablers mapped to any race constrainer. | ||
Parameters | boolean | match | true for enablers mapped to any race constrainer,
false to match enablers mapped to no race constrainers |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledRaceConstrainerTerms | ||
Description |
Clears the race constrainer 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 | getRaceConstrainerEnablerQueryRecord | ||
Description |
Gets the race constrainer enabler query record
corresponding to the given | ||
Parameters | osid.type.Type | raceConstrainerEnablerRecordType | a race constrainer enabler record type |
Return | osid.voting.rules.records.RaceConstrainerEnablerQueryRecord | the race constrainer enabler query record | |
Errors | NULL_ARGUMENT | raceConstrainerEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(raceConstrainerEnablerRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |