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

Interface	osid.voting.rules.RaceProcessorSearchSession
Implements	`osid.voting.rules.RaceProcessorQuerySession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session provides methods for searching among `RaceProcessor` objects. The search query is constructed using the `RaceProcessoryQuery` . `getRaceProcessorsByQuery()` is the basic search method and returns a list of `RaceProcessors` . A more advanced search may be performed with `getRaceProcessorsBySearch()` .It accepts a `RaceProcessorSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as voting. `getRaceProcessorsBySearch()` returns a `RaceProcessorSearchResults` that can be used to access the resulting `RaceProcessorList` or be used to perform a search within the result set through `RaceProcessorSearch` . This session defines views that offer differing behaviors for searching. federated polls view: searches include race processor in polls of which this polls is an ancestor in the polls hierarchy isolated polls view: searches are restricted to race processor in this polls `RaceProcessors` may have a query record indicated by their respective record types. Thequery record is accessed via the `RaceProcessorQuery` .
Method	getRaceProcessorSearch
Description	Gets a race processor search.
Return	`osid.voting.rules.RaceProcessorSearch`		the race processor search
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorSearchOrder
Description	Gets a race processor search order. The `RaceProcessorSearchOrder` is supplied to a `RaceProcessorSearch` to specify the ordering of results.
Return	`osid.voting.rules.RaceProcessorSearchOrder`		the race processor search order
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.voting.rules.RaceProcessorQuery`	`raceProcessorQuery`	the race processor query
Parameters	`osid.voting.rules.RaceProcessorSearch`	`raceProcessorSearch`	the race processor search
Return	`osid.voting.rules.RaceProcessorSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`raceProcessorQuery` or `raceProcessorSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`raceProcessorQuery` or `raceProcessorSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorQueryFromInspector
Description	Gets a race processor query from an inspector. The inspector is available from a `RaceProcessorSearchResults` .
Parameters	`osid.voting.rules.RaceProcessorQueryInspector`	`raceProcessorQueryInspector`	a race processor query inspector
Return	`osid.voting.rules.RaceProcessorQuery`		the race processor query
Errors	NULL_ARGUMENT		`raceProcessorQueryInspector` is `null`
Errors	UNSUPPORTED		`raceProcessorQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.