OSID - osid.voting.RaceQuery Service Interface Definition

Interface	osid.voting.RaceQuery
Implements	`osid.OsidGovernatorQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.voting.BallotQuery`
	`osid.voting.CandidateQuery`
	`osid.voting.RaceQuerySession`
	`osid.voting.RaceSearchSession`
	`osid.voting.RaceSmartPollsSession`
	`osid.voting.rules.RaceConstrainerQuery`
	`osid.voting.rules.RaceProcessorQuery`
Description	This is the query for searching races. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchBallotId
Description	Sets the ballot `Id` for this query.
Parameters	`osid.id.Id`	`ballotId`	a ballot `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`ballotId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBallotIdTerms
Description	Clears the ballot `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBallotQuery
Description	Tests if a `BallotQuery` is available.
Return	`boolean`		`true` if a ballot query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBallotQuery
Description	Gets the query for a ballot. Multiple retrievals produce a nested `OR` term.
Return	`osid.voting.BallotQuery`		the ballot query
Errors	UNIMPLEMENTED		`supportsBallotQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBallotQuery()` is `true`.
Method	clearBallotTerms
Description	Clears the ballot terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCandidateId
Description	Sets the candidate `Id` for this query.
Parameters	`osid.id.Id`	`candidateId`	a candidate `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`candidateId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCandidateIdTerms
Description	Clears the candidate `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCandidateQuery
Description	Tests if a `CandidateQuery` is available.
Return	`boolean`		`true` if a candidate query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCandidateQuery
Description	Gets the query for a candidate. Multiple retrievals produce a nested `OR` term.
Return	`osid.voting.CandidateQuery`		the candidate query
Errors	UNIMPLEMENTED		`supportsCandidateQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCandidateQuery()` is `true`.
Method	matchAnyCandidate
Description	Matches polls with any candidate.
Parameters	`boolean`	`match`	`true` to match polls with any candidate, `false` to match polls with no candidates
Compliance	`mandatory`		This method must be implemented.
Method	clearCandidateTerms
Description	Clears the candidate terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPollsId
Description	Sets the polls `Id` for this query.
Parameters	`osid.id.Id`	`pollsid`	a 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` 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 terms.
Compliance	`mandatory`		This method must be implemented.
Method	getRaceQueryRecord
Description	Gets the race query record corresponding to the given `Race` record `Type`.Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`raceRecordType`	a race record type
Return	`osid.voting.records.RaceQueryRecord`		the race query record
Errors	NULL_ARGUMENT		`raceRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(raceRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.