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

Interface	osid.voting.rules.BallotConstrainerEnablerSearchSession
Implements	`osid.voting.rules.BallotConstrainerEnablerQuerySession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session provides methods for searching among `BallotConstrainerEnabler` objects. The search query is constructed using the `BallotConstrainerEnableryQuery` . `getBallotConstrainerEnablersByQuery()` is the basic search method and returns a list of `BallotConstrainerEnablers` . A more advanced search may be performed with `getBallotConstrainerEnablersBySearch()` .It accepts a `BallotConstrainerEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as voting. `getBallotConstrainerEnablersBySearch()` returns a `BallotConstrainerEnablerSearchResults` that can be used to access the resulting `BallotConstrainerEnablerList` or be used to perform a search within the result set through `BallotConstrainerEnablerSearch` . This session defines views that offer differing behaviors for searching. federated polls view: searches include ballot constrainer enablers in polls of which this polls is an ancestor in the polls hierarchy isolated polls view: searches are restricted to ballot constrainer enablers in this polls `BallotConstrainerEnablers` may have a query record indicated by their respective record types. The query record is accessed via the `BallotConstrainerEnablerQuery` .
Method	getBallotConstrainerEnablerSearch
Description	Gets a ballot constrainer enabler search.
Return	`osid.voting.rules.BallotConstrainerEnablerSearch`		the ballot constrainer enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerEnablerSearchOrder
Description	Gets a ballot constrainer enabler search order. The `BallotConstrainerEnablerSearchOrder` is supplied to a `BallotConstrainerEnablerSearch` to specify the ordering of results.
Return	`osid.voting.rules.BallotConstrainerEnablerSearchOrder`		the ballot constrainer enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.voting.rules.BallotConstrainerEnablerQuery`	`ballotConstrainerEnablerQuery`	the ballot constrainer enabler query
Parameters	`osid.voting.rules.BallotConstrainerEnablerSearch`	`ballotConstrainerEnablerSearch`	the ballot constrainer enabler search
Return	`osid.voting.rules.BallotConstrainerEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`ballotConstrainerEnablerQuery` or `ballotConstrainerEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`ballotConstrainerEnablerQuery` or `ballotConstrainerEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerEnablerQueryFromInspector
Description	Gets a ballot constrainer enabler query from an inspector. The inspector is available from a `BallotConstrainerEnablerSearchResults` .
Parameters	`osid.voting.rules.BallotConstrainerEnablerQueryInspector`	`ballotConstrainerEnablerQueryInspector`	a ballot constrainer enabler query inspector
Return	`osid.voting.rules.BallotConstrainerEnablerQuery`		the ballot constrainer enabler query
Errors	NULL_ARGUMENT		`ballotConstrainerEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`ballotConstrainerEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.