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

Interface	osid.voting.rules.RaceProcessorNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.voting.rules.VotingRulesManager`
Used By	`osid.voting.rules.VotingRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `RaceProcessor` objects in this `Polls`. This also includes existing `RaceProcessors` that may appear or disappear due to changes in the `Polls` hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. The two views defined in this session correspond to the views in the `RaceProcessorLookupSession`.
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	canRegisterForRaceProcessorNotifications
Description	Tests if this user can register for `RaceProcessor` notifications. 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 notification operations.
Return	`boolean`		`false` if notification 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 in polls which are children of this polls 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 notifications to this polls only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableRaceProcessorNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRaceProcessorNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRaceProcessorNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRaceProcessorNotification
Description	Acknowledge a race processor notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRaceProcessors
Description	Register for notifications of new race processors. `RaceProcessorReceiver.newRaceProcessors()` is invoked when a new `RaceProcessor` appears in this polls.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRaceProcessors
Description	Registers for notification of updated polls. `RaceProcessorReceiver.changedRaceProcessors()` is invoked when a race processor in this polls is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRaceProcessor
Description	Registers for notification of an updated race processor. `ProvisionableReceiver.changedRaceProcessors()` is invoked when the specified race processor in this polls is changed.
Parameters	`osid.id.Id`	`raceProcessorId`	the `Id` of the `RaceProcessor` to monitor
Errors	NULL_ARGUMENT		`raceProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRaceProcessors
Description	Registers for notification of deleted race processors. `RaceProcessorReceiver.deletedRaceProcessors()` is invoked when a race processor is deleted or removed from this polls.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRaceProcessor
Description	Registers for notification of a deleted race processor. `RaceProcessorReceiver.deletedRaceProcessors()` is invoked when the specified race processor is deleted or removed from this polls.
Parameters	`osid.id.Id`	`raceProcessorId`	the `Id` of the `RaceProcessor` to monitor
Errors	NULL_ARGUMENT		`raceProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.