OSID - osid.voting.CandidateSearchSession Service Interface Definition

Interface	osid.voting.CandidateSearchSession
Implements	`osid.voting.CandidateQuerySession`
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` . `getCandidatesByQuery()` is the basic search method and returns a list of `Candidates` . A more advanced search may be performed with `getCandidatesBySearch()` .It accepts an `CandidateSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getCandidatesBySearch()` returns an `CandidateSearchResults` that can be used to access the resulting `CandidateList` or be used to perform a search within the result set through `CandidateList` . 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 candidiate query record indicated by their respective record types. The candidiate query record is accessed via the `CandidateQuery` .
Method	getCandidateSearch
Description	Gets a candidate search.
Return	`osid.voting.CandidateSearch`		the candidate search
Compliance	`mandatory`		This method must be implemented.
Method	getCandidateSearchOrder
Description	Gets a candidate search order. The `CandidateSearchOrder` is supplied to a `CandidateSearch` to specify the ordering of results.
Return	`osid.voting.CandidateSearchOrder`		the candidate search order
Compliance	`mandatory`		This method must be implemented.
Method	getCandidatesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.voting.CandidateQuery`	`candidateQuery`	the candidate query
Parameters	`osid.voting.CandidateSearch`	`candidateSearch`	the candidate search
Return	`osid.voting.CandidateSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`candidateQuery` or `candidateSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`candidateQuery` or `candidateSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCandidateQueryFromInspector
Description	Gets a candidate query from an inspector. The inspector is available from a `CandidateSearchResults` .
Parameters	`osid.voting.CandidateQueryInspector`	`candidateQueryInspector`	a candidate query inspector
Return	`osid.voting.CandidateQuery`		the candidate query
Errors	NULL_ARGUMENT		`candidateQueryInspector` is `null`
Errors	UNSUPPORTED		`candidateQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.