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

Interface	osid.voting.rules.RaceConstrainerQuery
Implements	`osid.OsidConstrainerQuery`
Used By	`osid.voting.rules.RaceConstrainerEnablerQuery`
	`osid.voting.rules.RaceConstrainerQuerySession`
	`osid.voting.rules.RaceConstrainerSearchSession`
	`osid.voting.rules.RaceConstrainerSmartPollsSession`
Description	This is the query for searching race constrainers. Each method match specifies a `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledRaceId
Description	Matches mapped to a 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 constrainers mapped to any race.
Parameters	`boolean`	`match`	`true` for constrainers mapped to any race, `false` to match constrainers mapped to no races
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 constrainers 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	getRaceConstrainerQueryRecord
Description	Gets the race constrainer query record corresponding to the given `RaceConstrainer` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`raceConstrainerRecordType`	a race constrainer record type
Return	`osid.voting.rules.records.RaceConstrainerQueryRecord`		the race constrainer query record
Errors	NULL_ARGUMENT		`raceConstrainerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(raceConstrainerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.