OSID - osid.voting.RaceSearchSession Service Interface Definition

Interface	osid.voting.RaceSearchSession
Implements	`osid.voting.RaceQuerySession`
Used By	`osid.voting.VotingManager`
Used By	`osid.voting.VotingProxyManager`
Description	This session provides methods for searching among races. The search query is constructed using the `RaceQuery` . `getRacesByQuery()` is the basic search method and returns a list of races. A more advanced search may be performed with `getRacesBySearch()` .It accepts a `RaceSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getRacesBySearch()` returns a `RaceSearchResults` that can be used to access the resulting `RaceList` or be used to perform a search within the result set through `RaceSearch` . This session defines views that offer differing behaviors for searching. federated polls view: searches include races in polls of which this polls is an ancestor in the polls hierarchy isolated polls view: searches are restricted to races in this polls only
Method	getRaceSearch
Description	Gets a race search.
Return	`osid.voting.RaceSearch`		the race search
Compliance	`mandatory`		This method must be implemented.
Method	getRaceSearchOrder
Description	Gets a race search order. The `RaceSearchOrder` is supplied to a `RaceSearch` to specify the ordering of results.
Return	`osid.voting.RaceSearchOrder`		the race search order
Compliance	`mandatory`		This method must be implemented.
Method	getRacesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.voting.RaceQuery`	`raceQuery`	the race query
Parameters	`osid.voting.RaceSearch`	`raceSearch`	the race search
Return	`osid.voting.RaceSearchResults`		the returned race search results
Errors	NULL_ARGUMENT		`raceQuery` or `raceSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`raceQuery` or `raceSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRaceQueryFromInspector
Description	Gets a race query from an inspector. The inspector is available from a `RaceSearchResults` .
Parameters	`osid.voting.RaceQueryInspector`	`raceQueryInspector`	a race query inspector
Return	`osid.voting.RaceQuery`		the race query
Errors	NULL_ARGUMENT		`raceQueryInspector` is `null`
Errors	UNSUPPORTED		`raceQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.