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

Interface	osid.voting.rules.RaceProcessorQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.voting.rules.RaceProcessorSearchSession`
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 `RaceProcessorQuery`. 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 Race processor may have a query record indicated by their respective record types. The query record is accessed via the `RaceProcessorQuery`.
Method	getPollsId
Description	Gets the `Polls` `Id` associated with this session.
Return	`osid.id.Id`		the `Polls Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPolls
Description	Gets the `Polls` associated with this session.
Return	`osid.voting.Polls`		the polls
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchRaceProcessors
Description	Tests if this user can perform `RaceProcessor` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedPollsView
Description	Federates the view for methods in this session. A federated view will include race processor in polls which are children of this race in the polls hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedPollsView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this polls only.
Compliance	`mandatory`		This method is must be implemented.
Method	getRaceProcessorQuery
Description	Gets a race processor query.
Return	`osid.voting.rules.RaceProcessorQuery`		the race processor query
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorsByQuery
Description	Gets a list of `RaceProcessors` matching the given race processor query.
Parameters	`osid.voting.rules.RaceProcessorQuery`	`raceProcessorQuery`	the race processor query
Return	`osid.voting.rules.RaceProcessorList`		the returned `RaceProcessorList`
Errors	NULL_ARGUMENT		`raceProcessorQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`raceProcessorQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.