OSID - osid.voting.RaceSmartPollsSession Service Interface Definition

Interface	osid.voting.RaceSmartPollsSession
Implements	`osid.OsidSession`
Used By	`osid.voting.VotingManager`
Used By	`osid.voting.VotingProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `RaceQuery` can be retrieved from this session and mapped to this `Polls` to create a virtual collection of `Races`. The entries may be sequenced using the `RaceSearchOrder` from this session. This `Polls` has a default query that matches any race and a default search order that specifies no sequencing. The queries may be examined using a `RaceQueryInspector`. The query may be modified by converting the inspector back to a `RaceQuery`.
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` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartPolls
Description	Tests if this user can manage smart polls. 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 opt not to offer smart operations.
Return	`boolean`		`false` if smart polls methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRaceQuery
Description	Gets a race query.
Return	`osid.voting.RaceQuery`		the race query
Compliance	`mandatory`		This method must be implemented.
Method	getRaceSearchOrder
Description	Gets a race search order.
Return	`osid.voting.RaceSearchOrder`		the race search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRaceQuery
Description	Applies a race query to this polls.
Parameters	`osid.voting.RaceQuery`	`raceQuery`	the race query
Errors	NULL_ARGUMENT		`raceQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`raceQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRaceQuery
Description	Gets a race query inspector for this polls.
Return	`osid.voting.RaceQueryInspector`		the race query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRaceSequencing
Description	Applies a race search order to this polls.
Parameters	`osid.voting.RaceSearchOrder`	`raceSearchOrder`	the race search order
Errors	NULL_ARGUMENT		`raceSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`raceSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRaceQueryFromInspector
Description	Gets a race query from an inspector.
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.