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

Interface	osid.voting.rules.RaceProcessorEnablerSearchSession
Implements	`osid.voting.rules.RaceProcessorEnablerQuerySession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session provides methods for searching among `RaceProcessorEnabler` objects. The search query is constructed using the `RaceProcessorEnableryQuery` . `getRaceProcessorEnablersByQuery()` is the basic search method and returns a list of `RaceProcessorEnablers` . A more advanced search may be performed with `getRaceProcessorEnablersBySearch()` .It accepts a `RaceProcessorEnablerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as voting. `getRaceProcessorEnablersBySearch()` returns a `RaceProcessorEnablerSearchResults` that can be used to access the resulting `RaceProcessorEnablerList` or be used to perform a search within the result set through `RaceProcessorEnablerSearch` . This session defines views that offer differing behaviors for searching. federated polls view: searches include race processor enablers in polls of which this polls is an ancestor in the polls hierarchy isolated polls view: searches are restricted to race processor enablers in this polls `RaceProcessorEnablers` may have a query record indicated by their respective query record types. The record is accessed via the `RaceProcessorEnablerQuery` .
Method	getRaceProcessorEnablerSearch
Description	Gets a race processor enabler search.
Return	`osid.voting.rules.RaceProcessorEnablerSearch`		the race processor enabler search
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorEnablerSearchOrder
Description	Gets a race processor enabler search order. The `RaceProcessorEnablerSearchOrder` is supplied to a `RaceProcessorEnablerSearch` to specify the ordering of results.
Return	`osid.voting.rules.RaceProcessorEnablerSearchOrder`		the race processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorEnablersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.voting.rules.RaceProcessorEnablerQuery`	`raceProcessorEnablerQuery`	the race processor enabler query
Parameters	`osid.voting.rules.RaceProcessorEnablerSearch`	`raceProcessorEnablerSearch`	the race processor enabler search
Return	`osid.voting.rules.RaceProcessorEnablerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`raceProcessorEnablerQuery` or `raceProcessorEnablerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`raceProcessorEnablerQuery` or `raceProcessorEnablerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorEnablerQueryFromInspector
Description	Gets a race processor enabler query from an inspector. The inspector is available from a `RaceProcessorEnablerSearchResults` .
Parameters	`osid.voting.rules.RaceProcessorEnablerQueryInspector`	`raceProcessorEnablerQueryInspector`	a race processor enabler query inspector
Return	`osid.voting.rules.RaceProcessorEnablerQuery`		the race processor enabler query
Errors	NULL_ARGUMENT		`raceProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`raceProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.