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

Interface	osid.voting.rules.VoteEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.voting.rules.VoteEnablerQuerySession`
	`osid.voting.rules.VoteEnablerSearchSession`
	`osid.voting.rules.VoteEnablerSmartPollsSession`
Description	This is the query for searching vote enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledVoteId
Description	Matches mapped to the vote.
Parameters	`osid.id.Id`	`voteId`	the vote `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`voteId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledVoteIdTerms
Description	Clears the vote `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledVoteQuery
Description	Tests if a `VoteQuery` is available.
Return	`boolean`		`true` if a vote query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledVoteQuery
Description	Gets the query for a vote. Multiple retrievals produce a nested `OR` term.
Return	`osid.voting.VoteQuery`		the vote query
Errors	UNIMPLEMENTED		`supportsRuledVoteQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledVoteQuery()` is `true`.
Method	matchAnyRuledVote
Description	Matches mapped to any vote.
Parameters	`boolean`	`match`	`true` for mapped to any vote, `false` to match mapped to no vote
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledVoteTerms
Description	Clears the vote query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPollsId
Description	Sets the polls `Id` for this query to match votes assigned to 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	getVoteEnablerQueryRecord
Description	Gets the vote enabler query record corresponding to the given `VoteEnabler` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`voteEnablerRecordType`	a vote enabler record type
Return	`osid.voting.rules.records.VoteEnablerQueryRecord`		the vote enabler query record
Errors	NULL_ARGUMENT		`voteEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(voteEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.