OSID - osid.voting.rules.RaceProcessorQuery Service Interface Definition

Interface	osid.voting.rules.RaceProcessorQuery
Implements	`osid.OsidProcessorQuery`
Used By	`osid.voting.rules.RaceProcessorEnablerQuery`
	`osid.voting.rules.RaceProcessorQuerySession`
	`osid.voting.rules.RaceProcessorSearchSession`
	`osid.voting.rules.RaceProcessorSmartPollsSession`
Description	This is the query for searching race processors. Each method match specifies a `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchMaximumWinners
Description	Matches rules with a maximum winners value between the given range inclusive.
Parameters	`cardinal`	`low`	start of range
	`cardinal`	`high`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMaximumWinners
Description	Matches rules with any maximum winner value.
Parameters	`boolean`	`match`	`true` to match rules with a maximum winner value, `false` to match rules with no maximum winner value
Compliance	`mandatory`		This method must be implemented.
Method	clearMaximumWinnersTerms
Description	Clears the maximum winners terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumPercentageToWin
Description	Matches rules with a minimum percentage to win value between the given range inclusive.
Parameters	`cardinal`	`low`	start of range
	`cardinal`	`high`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMinimumPercentageToWin
Description	Matches rules with any minimum percentage to win value.
Parameters	`boolean`	`match`	`true` to match rules with a minimum value, `false` to match rules with no minimum value
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumPercentageToWinTerms
Description	Clears the minimum percentage to win terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchMinimumVotesToWin
Description	Matches rules with a minimum votes to win value between the given range inclusive.
Parameters	`cardinal`	`low`	start of range
	`cardinal`	`high`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`low` is greater than `high`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyMinimumVotesToWin
Description	Matches rules with any minimum votes to win value.
Parameters	`boolean`	`match`	`true` to match rules with a minimum value, `false` to match rules with no minimum value
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumVotesToWinTerms
Description	Clears the minimum votes to win terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRuledRaceId
Description	Matches rules mapped to the race.
Parameters	`osid.id.Id`	`raceId`	the race `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`raceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledRaceIdTerms
Description	Clears the race `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledRaceQuery
Description	Tests if a `RaceQuery` is available.
Return	`boolean`		`true` if a race query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledRaceQuery
Description	Gets the query for a race. Multiple retrievals produce a nested `OR` term.
Return	`osid.voting.RaceQuery`		the race query
Errors	UNIMPLEMENTED		`supportsRuledRaceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledRaceQuery()` is `true`.
Method	matchAnyRuledRace
Description	Matches any rule mapped to any race.
Parameters	`boolean`	`match`	`true` for rules mapped to any race, `false` to match rules mapped to no race
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledRaceTerms
Description	Clears the race query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPollsId
Description	Matches rules mapped to the polls.
Parameters	`osid.id.Id`	`pollsId`	the polls `Id`
Parameters	`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 `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPollsQuery
Description	Tests if a `PollsQuery` is available.
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 `OR` term.
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	getRaceProcessorQueryRecord
Description	Gets the race processor query record corresponding to the given `RaceProcessor` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`raceProcessorRecordType`	a race processor record type
Return	`osid.voting.rules.records.RaceProcessorQueryRecord`		the race processor query record
Errors	NULL_ARGUMENT		`raceProcessorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(raceProcessorRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.