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

Interface	osid.voting.rules.RaceProcessorEnablerSmartPollsSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic polls. a `RaceProcessorEnablerQuery` can be retrieved from this session and mapped to this `Polls` to create a virtual collection of race processor enablers. The race processor enablers may be sequenced using the `RaceProcessorEnablerSearchOrder` from this session. This `Polls` has a default query that matches any race processor enabler and a default search order that specifies no sequencing. The queries may be examined using a `RaceProcessorEnablerQueryInspector.` The query may be modified by converting the inspector back to a `RaceProcessorEnablerQuery.`
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	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 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 operations to unauthorized users.
Return	`boolean`		`false` if smart polls management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorEnablerQuery
Description	Gets a race processor enabler query.
Return	`osid.voting.rules.RaceProcessorEnablerQuery`		the race processor enabler query
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorEnablerSearchOrder
Description	Gets a race processor enabler search order.
Return	`osid.voting.rules.RaceProcessorEnablerSearchOrder`		the race processor enabler search order
Compliance	`mandatory`		This method must be implemented.
Method	applyRaceProcessorEnablerQuery
Description	Applies a race processor enabler query to this polls.
Parameters	`osid.voting.rules.RaceProcessorEnablerQuery`	`raceProcessorEnablerQuery`	the race processor enabler query
Errors	NULL_ARGUMENT		`raceProcessorEnablerQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`raceProcessorEnablerQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectRaceProcessorEnablerQuery
Description	Gets a race processor enabler query inspector for this polls.
Return	`osid.voting.rules.RaceProcessorEnablerQueryInspector`		the race processor enabler query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyRaceProcessorEnablerSequencing
Description	Applies a race processor enabler search order to this polls.
Parameters	`osid.voting.rules.RaceProcessorEnablerSearchOrder`	`raceProcessorEnablerSearchOrder`	the race processor enabler search order
Errors	NULL_ARGUMENT		`raceProcessorEnablerSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`raceProcessorEnablerSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getRaceProcessorEnablerQueryFromInspector
Description	Gets a race processor enabler query from an inspector.
Parameters	`osid.voting.rules.RaceProcessorEnablerQueryInspector`	`raceProcessorEnablerQueryInspector`	a race processor enabler query inspector
Return	`osid.voting.rules.RaceProcessorEnablerQuery`		the race processor enabler query
Errors	NULL_ARGUMENT		`raceProcessorEnablerQueryInspector` is `null`
Errors	UNSUPPORTED		`raceProcessorEnablerQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.