OSID - osid.voting.PollsSearchSession Service Interface Definition

Interface	osid.voting.PollsSearchSession
Implements	`osid.voting.PollsQuerySession`
Used By	`osid.voting.VotingManager`
Used By	`osid.voting.VotingProxyManager`
Description	This session provides methods for searching among `Polls` objects. The search query is constructed using the `PollsQuery` . `getPollsByQuery()` is the basic search method and returns a list of `Polls` objects.A more advanced search may be performed with `getPollsBySearch()` .It accepts a `PollsSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getPollsBySearch()` returns a `PollsSearchResults` that can be used to access the resulting `PollsList` or be used to perform a search within the result set through `PollsSearch` . Polls may have a polls query record indicated by their respective record types. The polls query record is accessed via the `PollsQuery` .
Method	getPollsSearch
Description	Gets a polls search.
Return	`osid.voting.PollsSearch`		the polls search
Compliance	`mandatory`		This method must be implemented.
Method	getPollsSearchOrder
Description	Gets a polls search order. The `PollsSearchOrder` is supplied to a `PollsSearch` to specify the ordering of results.
Return	`osid.voting.PollsSearchOrder`		the polls search order
Compliance	`mandatory`		This method must be implemented.
Method	getPollssBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.voting.PollsQuery`	`pollsQuery`	the polls query
Parameters	`osid.voting.PollsSearch`	`pollsSearch`	the polls search
Return	`osid.voting.PollsSearchResults`		the polls search results
Errors	NULL_ARGUMENT		`pollsQuery` or `pollsSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`pollsQuery` or `pollsSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getPollsQueryFromInspector
Description	Gets a polls query from an inspector. The inspector is available from a `PollsSearchResults` .
Parameters	`osid.voting.PollsQueryInspector`	`pollsQueryInspector`	a polls query inspector
Return	`osid.voting.PollsQuery`		the polls query
Errors	NULL_ARGUMENT		`pollsQueryInspector` is `null`
Errors	UNSUPPORTED		`pollsQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.