OSID - osid.voting.BallotQuery Service Interface Definition

Interface	osid.voting.BallotQuery
Implements	`osid.OsidGovernatorQuery`
Implements	`osid.OsidTemporalQuery`
Used By	`osid.voting.BallotQuerySession`
	`osid.voting.BallotSearchSession`
	`osid.voting.BallotSmartPollsSession`
	`osid.voting.RaceQuery`
	`osid.voting.rules.BallotConstrainerQuery`
Description	This is the query for searching ballots. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchCommissionerId
Description	Sets a commissioner `Id` for this query.
Parameters	`osid.id.Id`	`commissionerId`	a commissioner `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`commissionerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCommissionerIdTerms
Description	Clears the commissioner `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCommissionerQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a commissioner query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommissionerQuery
Description	Gets the query for a commissioner. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the commissioner query
Errors	UNIMPLEMENTED		`supportsCommissionerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCommissionerQuery()` is `true`.
Method	matchAnyCommissioner
Description	Matches objects with any commissioner.
Parameters	`boolean`	`match`	`true` to match objects with any commissioner, `false` to match objects with no commissioner
Compliance	`mandatory`		This method must be implemented.
Method	clearCommissionerTerms
Description	Clears the commissioner query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRevote
Description	Matches ballots that allow vote modification.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearRevoteTerms
Description	Clears the revote ballot terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRaceId
Description	Sets the race `Id` for this query.
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	clearRaceIdTerms
Description	Clears the race `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRaceQuery
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	getRaceQuery
Description	Gets the query for a race. Multiple retrievals produce a nested `OR` term.
Return	`osid.voting.RaceQuery`		the race query
Errors	UNIMPLEMENTED		`supportsRaceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRaceQuery()` is `true`.
Method	matchAnyRace
Description	Matches ballots with any race.
Parameters	`boolean`	`match`	`true` to match any race, `false` to match ballots with no races
Compliance	`mandatory`		This method must be implemented.
Method	clearRaceTerms
Description	Clears the race terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPollsId
Description	Sets the polls `Id` for this query.
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` 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	getBallotQueryRecord
Description	Gets the ballot query record corresponding to the given `Ballot` record `Type` .Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`ballotRecordType`	a ballot record type
Return	`osid.voting.records.BallotQueryRecord`		the ballot query record
Errors	NULL_ARGUMENT		`ballotRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(ballotRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.