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

Interface	osid.voting.rules.VoteEnablerSearchSession
Implements	`osid.voting.rules.VoteEnablerQuerySession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session provides methods for searching among `VoteEnablers` . The search query is constructed using the `VoteEnablerQuery` . `getVoteEnablersByQuery()` is the basic search method and returns a list of `VoteEnablers` . A more advanced search may be performed with `getVoteEnablersBySearch()` .It accepts a `VoteEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getVoteEnablersBySearch()` returns a `VoteEnablerSearchResults` that can be used to access the resulting `VoteEnablerList` or be used to perform a search within the result set through Vot `eEnablerSearch` . This session defines views that offer differing behaviors for searching. federated polls view: searches include vote enablers in polls of which this polls is an ancestor in the polls hierarchy isolated polls view: searches are restricted to vote enablers in this polls Vote enablers may have a query record indicated by their respective record types. The query record is accessed via the `VoteEnablerQuery` .
Method	getVoteEnablerSearch
Description	Gets a vote enabler search.
Return	`osid.voting.rules.VoteEnablerSearch`		the vote enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getVoteEnablerSearchOrder
Description	Gets a vote enabler search order. The `VoteEnablerSearchOrder` is supplied to a `VoteEnablerSearch` to specify the ordering of results.
Return	`osid.voting.rules.VoteEnablerSearchOrder`		the vote enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getVoteEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.voting.rules.VoteEnablerQuery`	`voteEnablerQuery`	the vote enabler query
Parameters	`osid.voting.rules.VoteEnablerSearch`	`voteEnablerSearch`	the vote enabler search
Return	`osid.voting.rules.VoteEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`voteEnablerQuery` or `voteEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`voteEnablerQuery` or `voteEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getVoteEnablerQueryFromInspector
Description	Gets a vote enabler query from an inspector. The inspector is available from a `VoteEnablerSearchResults` .
Parameters	`osid.voting.rules.VoteEnablerQueryInspector`	`voteEnablerQueryInspector`	a vote enabler query inspector
Return	`osid.voting.rules.VoteEnablerQuery`		the vote enabler query
Errors	NULL_ARGUMENT		`voteEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`voteEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.