OSID - osid.voting.CandidateQuerySession Service Interface Definition

Interface	osid.voting.CandidateQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.voting.CandidateSearchSession`
Used By	`osid.voting.VotingManager`
Used By	`osid.voting.VotingProxyManager`
Description	This session provides methods for searching among `Candidate` objects. The search query is constructed using the `CandidateQuery`. This session defines views that offer differing behaviors for searching. federated polls view: searches include candidates in polls of which this polls is a ancestor in the polls hierarchy isolated polls view: searches are restricted to candidates in this polls Candidates may have a candidate query record indicated by their respective record types. The candidate query record is accessed via the `CandidateQuery`.
Method	getPollsId
Description	Gets the `Polls` `Id` associated with this session.
Return	`osid.id.Id`		the `Polls Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPolls
Description	Gets the `Polls` associated with this session.
Return	`osid.voting.Polls`		the `Polls` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchCandidates
Description	Tests if this user can perform `Candidate` searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedPollsView
Description	Federates the view for methods in this session. A federated view will include candidates in polls which are children of this polls in the polls hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedPollsView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this polls only.
Compliance	`mandatory`		This method is must be implemented.
Method	getCandidateQuery
Description	Gets a candidate query. The returned query will not have an extension query.
Return	`osid.voting.CandidateQuery`		the candidate query
Compliance	`mandatory`		This method must be implemented.
Method	getCandidatesByQuery
Description	Gets a list of `Candidates` matching the given candidate query.
Parameters	`osid.voting.CandidateQuery`	`candidateQuery`	the candidate query
Return	`osid.voting.CandidateList`		the returned `CandidateList`
Errors	NULL_ARGUMENT		`candidateQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`candidateQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.