OSID - osid.voting.VoteSearchSession Service Interface Definition

Interface	osid.voting.VoteSearchSession
Implements	`osid.voting.VoteQuerySession`
Used By	`osid.voting.VotingManager`
Used By	`osid.voting.VotingProxyManager`
Description	This session provides methods for searching `Vote` objects. The search query is constructed using the `VoteQuery` . The vote record `Type` also specifies the record for the vote query. `getVotesByQuery()` is the basic search method and returns a list of `Votes` . A more advanced search may be performed with `getVotesBySearch()` . It accepts a `VoteSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getVotesBySearch()` returns an `VoteSearchResults` that can be used to access the resulting `VoteList` or be used to perform a search within the result set through `VoteSearch` . This session defines views that offer differing behaviors for searching. federated polls view: searches include votes in polls of which these polls is an ancestor in the polls hierarchy isolated polls view: searches are restricted to votes in these polls only Votes may have a query record indicated by their respective record types. The query record is accessed via the `VoteQuery` .
Method	getVoteSearch
Description	Gets a vote search.
Return	`osid.voting.VoteSearch`		the vote search
Compliance	`mandatory`		This method must be implemented.
Method	getVoteSearchOrder
Description	Gets a vote search order. The `VoteSearchOrder` is supplied to a `VoteSearch` to specify the ordering of results.
Return	`osid.voting.VoteSearchOrder`		the vote search order
Compliance	`mandatory`		This method must be implemented.
Method	getVotesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.voting.VoteQuery`	`voteQuery`	the vote search query
Parameters	`osid.voting.VoteSearch`	`voteSearch`	the vote search
Return	`osid.voting.VoteSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`voteQuery` or voteSearch is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`voteSearch` or voteQuery is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getVoteQueryFromInspector
Description	Gets a vote query from an inspector. The inspector is available from a `VoteSearchResults` .
Parameters	`osid.voting.VoteQueryInspector`	`voteQueryInspector`	a vote query inspector
Return	`osid.voting.VoteQuery`		the vote query
Errors	NULL_ARGUMENT		`voteQueryInspector` is `null`
Errors	UNSUPPORTED		`voteQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.