OSID - osid.voting.BallotSearchSession Service Interface Definition

Interface	osid.voting.BallotSearchSession
Implements	`osid.voting.BallotQuerySession`
Used By	`osid.voting.VotingManager`
Used By	`osid.voting.VotingProxyManager`
Description	This session provides methods for searching among `Ballot` objects. The search query is constructed using the `BallotQuery` . `getBallotsByQuery()` is the basic search method and returns a list of `Ballots` . A more advanced search may be performed with `getBallotsBySearch()` .It accepts an `BallotSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getBallotsBySearch()` returns an `BallotSearchResults` that can be used to access the resulting `BallotList` or be used to perform a search within the result set through `BallotList` . This session defines views that offer differing behaviors for searching. federated polls view: searches include ballots in polls of which this polls is a ancestor in the polls hierarchy isolated polls view: searches are restricted to ballots in this polls Ballots may have a ballot query record indicated by their respective record types. The ballot query record is accessed via the `BallotQuery` .
Method	getBallotSearch
Description	Gets a ballot search.
Return	`osid.voting.BallotSearch`		the ballot search
Compliance	`mandatory`		This method must be implemented.
Method	getBallotSearchOrder
Description	Gets a ballot search order. The `BallotSearchOrder` is supplied to a `BallotSearch` to specify the ordering of results.
Return	`osid.voting.BallotSearchOrder`		the ballot search order
Compliance	`mandatory`		This method must be implemented.
Method	getBallotsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.voting.BallotQuery`	`ballotQuery`	the ballot query
Parameters	`osid.voting.BallotSearch`	`ballotSearch`	the ballot search
Return	`osid.voting.BallotSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`ballotQuery` or `ballotSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`ballotQuery` or `ballotSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBallotQueryFromInspector
Description	Gets a ballot query from an inspector. The inspector is available from a `BallotSearchResults` .
Parameters	`osid.voting.BallotQueryInspector`	`ballotQueryInspector`	a ballot query inspector
Return	`osid.voting.BallotQuery`		the ballot query
Errors	NULL_ARGUMENT		`ballotQueryInspector` is `null`
Errors	UNSUPPORTED		`ballotQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.