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

Interface	osid.voting.rules.BallotConstrainerEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.voting.rules.BallotConstrainerEnablerQuerySession`
	`osid.voting.rules.BallotConstrainerEnablerSearchSession`
	`osid.voting.rules.BallotConstrainerEnablerSmartPollsSession`
Description	This is the query for searching ballot constrainer enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchRuledBallotConstrainerId
Description	Matches enablers mapped to the ballot constrainer.
Parameters	`osid.id.Id`	`ballotConstrainerId`	the ballot constrainer `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`ballotConstrainerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledBallotConstrainerIdTerms
Description	Clears the ballot constrainer `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledBallotConstrainerQuery
Description	Tests if a `BallotConstrainerQuery` is available.
Return	`boolean`		`true` if a ballot constrainer query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledBallotConstrainerQuery
Description	Gets the query for a ballot constrainer. Multiple retrievals produce a nested `OR` term.
Return	`osid.voting.rules.BallotConstrainerQuery`		the ballot constrainer query
Errors	UNIMPLEMENTED		`supportsRuledBallotConstrainerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledBallotConstrainerQuery()` is `true` .
Method	matchAnyRuledBallotConstrainer
Description	Matches enablers mapped to any ballot constrainer.
Parameters	`boolean`	`match`	`true` for enablers mapped to any ballot constrainer, `false` to match enablers mapped to no ballot constrainers
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledBallotConstrainerTerms
Description	Clears the ballot constrainer query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPollsId
Description	Matches enablers 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	getBallotConstrainerEnablerQueryRecord
Description	Gets the ballot constrainer enabler query record corresponding to the given `BallotConstrainerEnabler` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`ballotConstrainerEnablerRecordType`	a ballot constrainer enabler record type
Return	`osid.voting.rules.records.BallotConstrainerEnablerQueryRecord`		the ballot constrainer enabler query record
Errors	NULL_ARGUMENT		`ballotConstrainerEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(ballotConstrainerEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.