OSID - osid.voting.PollsQuery Service Interface Definition

Interface	osid.voting.PollsQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching polls. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
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	matchAncestorPollsId
Description	Sets the polls `Id` for this query to match polls that have the specified polls as an ancestor.
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	clearAncestorPollsIdTerms
Description	Clears the ancestor polls `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorPollsQuery
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	getAncestorPollsQuery
Description	Gets the query for a polls. Multiple retrievals produce a nested `OR` term.
Return	`osid.voting.PollsQuery`		the polls query
Errors	UNIMPLEMENTED		`supportsAncestorPollsQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorPollsQuery()` is `true.`
Method	matchAnyAncestorPolls
Description	Matches polls with any ancestor.
Parameters	`boolean`	`match`	`true` to match polls with any ancestor, `false` to match root polls
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorPollsTerms
Description	Clears the ancestor polls terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantPollsId
Description	Sets the polls `Id` for this query to match polls that have the specified polls as a descendant.
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	clearDescendantPollsIdTerms
Description	Clears the descendant polls `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantPollsQuery
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	getDescendantPollsQuery
Description	Gets the query for a polls. Multiple retrievals produce a nested `OR` term.
Return	`osid.voting.PollsQuery`		the polls query
Errors	UNIMPLEMENTED		`supportsDescendantPollsQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantPollsQuery()` is `true.`
Method	matchAnyDescendantPolls
Description	Matches polls with any descendant.
Parameters	`boolean`	`match`	`true` to match polls with any descendant, `false` to match leaf polls
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantPollsTerms
Description	Clears the descendant polls terms.
Compliance	`mandatory`		This method must be implemented.
Method	getPollsQueryRecord
Description	Gets the polls query record corresponding to the given `Polls` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`pollsRecordType`	a polls record type
Return	`osid.voting.records.PollsQueryRecord`		the polls query record
Errors	NULL_ARGUMENT		`pollsRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(pollsRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.