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

Interface	osid.voting.rules.BallotConstrainerSearchSession
Implements	`osid.voting.rules.BallotConstrainerQuerySession`
Description	This session provides methods for searching among `BallotConstrainer` objects. The search query is constructed using the `BallotConstraineryQuery.` `getBallotConstrainersByQuery()` is the basic search method and returns a list of `BallotConstrainers.` A more advanced search may be performed with `getBallotConstrainersBySearch().` It accepts a `BallotConstrainerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as voting. `getBallotConstrainersBySearch()` returns a `BallotConstrainerSearchResults` that can be used to access the resulting `BallotConstrainerList` or be used to perform a search within the result set through `BallotConstrainerSearch.` This session defines views that offer differing behaviors for searching. federated polls view: searches include ballot constrainer in polls of which this polls is an ancestor in the polls hierarchy isolated polls view: searches are restricted to ballot constrainer in this polls `BallotConstrainers` may have a query record indicated by their respective record types. The query record is accessed via the `BallotConstrainerQuery.`
Method	getBallotConstrainerSearch
Description	Gets a ballot constrainer search.
Return	`osid.voting.rules.BallotConstrainerSearch`		the ballot constrainer search
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerSearchOrder
Description	Gets a ballot constrainer search order. The `BallotConstrainerSearchOrder` is supplied to a `BallotConstrainerSearch` to specify the ordering of results.
Return	`osid.voting.rules.BallotConstrainerSearchOrder`		the ballot constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.voting.rules.BallotConstrainerQuery`	`ballotConstrainerQuery`	the ballot constrainer query
Parameters	`osid.voting.rules.BallotConstrainerSearch`	`ballotConstrainerSearch`	the ballot constrainer search
Return	`osid.voting.rules.BallotConstrainerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`ballotConstrainerQuery` or `ballotConstrainerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`ballotConstrainerQuery` or `ballotConstrainerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerQueryFromInspector
Description	Gets a ballot constrainer query from an inspector. The inspector is available from a `BallotConstrainerSearchResults.`
Parameters	`osid.voting.rules.BallotConstrainerQueryInspector`	`ballotConstrainerQueryInspector`	a ballot constrainer query inspector
Return	`osid.voting.rules.BallotConstrainerQuery`		the ballot constrainer query
Errors	NULL_ARGUMENT		`ballotConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`ballotConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.