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

Interface	osid.voting.rules.RaceConstrainerSearchSession
Implements	`osid.voting.rules.RaceConstrainerQuerySession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session provides methods for searching among `RaceConstrainer` objects. The search query is constructed using the `RaceConstraineryQuery` . `getRaceConstrainersByQuery()` is the basic search method and returns a list of `RaceConstrainers` . A more advanced search may be performed with `getRaceConstrainersBySearch()` .It accepts a `RaceConstrainerSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as voting. `getRaceConstrainersBySearch()` returns a `RaceConstrainerSearchResults` that can be used to access the resulting `RaceConstrainerList` or be used to perform a search within the result set through `RaceConstrainerSearch` . This session defines views that offer differing behaviors for searching. federated polls view: searches include race constrainer in polls of which this polls is an ancestor in the polls hierarchy isolated polls view: searches are restricted to race constrainer in this polls `RaceConstrainers` may have a query record indicated by their respective record types. The query record is accessed via the `RaceConstrainerQuery` .
Method	getRaceConstrainerSearch
Description	Gets a race constrainer search.
Return	`osid.voting.rules.RaceConstrainerSearch`		the race constrainer search
Compliance	`mandatory`		This method must be implemented.
Method	getRaceConstrainerSearchOrder
Description	Gets a race constrainer search order. The `RaceConstrainerSearchOrder` is supplied to a `RaceConstrainerSearch` to specify the ordering of results.
Return	`osid.voting.rules.RaceConstrainerSearchOrder`		the race constrainer search order
Compliance	`mandatory`		This method must be implemented.
Method	getRaceConstrainersBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.voting.rules.RaceConstrainerQuery`	`raceConstrainerQuery`	the race constrainer query
Parameters	`osid.voting.rules.RaceConstrainerSearch`	`raceConstrainerSearch`	the race constrainer search
Return	`osid.voting.rules.RaceConstrainerSearchResults`		the returned search results
Errors	NULL_ARGUMENT		`raceConstrainerQuery` or `raceConstrainerSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`raceConstrainerQuery` or `raceConstrainerSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRaceConstrainerQueryFromInspector
Description	Gets a race constrainer query from an inspector. The inspector is available from a `RaceConstrainerSearchResults` .
Parameters	`osid.voting.rules.RaceConstrainerQueryInspector`	`raceConstrainerQueryInspector`	a race constrainer query inspector
Return	`osid.voting.rules.RaceConstrainerQuery`		the race constrainer query
Errors	NULL_ARGUMENT		`raceConstrainerQueryInspector` is `null`
Errors	UNSUPPORTED		`raceConstrainerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.