OSID - osid.voting.RaceNotificationSession Service Interface Definition

Interface	osid.voting.RaceNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.voting.VotingManager`
Used By	`osid.voting.VotingProxyManager`
Description	This session defines methods to receive notifications on new or deleted races. 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. This session registers notifications for the Race itself.
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	canRegisterForRaceNotifications
Description	Tests if this user can register for `Race` 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 races from parent 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 for races to this polls only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableRaceNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRaceNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRaceNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRaceNotification
Description	Acknowledge a race 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	registerForNewRaces
Description	Register for notifications of new races. `RaceReceiver.newRaces()` is invoked when a new `Race` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRacesForBallot
Description	Register for notifications of new races for a ballot. `RaceReceiver.newRaces()` is invoked when a new `Race` is created.
Parameters	`osid.id.Id`	`ballotId`	the `Id` of the `Ballot` to monitor
Errors	NULL_ARGUMENT		`ballotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRaces
Description	Register for notifications of new races. `RaceReceiver.changedRaces()` is invoked when a `Race` is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRacesForBallot
Description	Registers for notification of updated races for a ballot. `RaceReceiver.changedRaces()` is invoked when the specified race in this polls is changed.
Parameters	`osid.id.Id`	`ballotId`	the `Id` of the `Ballot` to monitor
Errors	NULL_ARGUMENT		`ballotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRace
Description	Registers for notification of an updated race. `RaceReceiver.changedRaces()` is invoked when the specified race in this polls is changed.
Parameters	`osid.id.Id`	`raceId`	the `Id` of the `Race` to monitor
Errors	NULL_ARGUMENT		`raceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRaces
Description	Registers for notification of deleted races. `RaceReceiver.deletedRaces()` is invoked when a race is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRacesForBallot
Description	Registers for notification of deleted races for ballot. `RaceReceiver.deletedRaces()` is invoked when the specified race is deleted or removed from this polls.
Parameters	`osid.id.Id`	`ballotId`	the `Id` of the `Ballot` to monitor
Errors	NULL_ARGUMENT		`ballotId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRace
Description	Registers for notification of a deleted race. `RaceReceiver.deletedRaces()` is invoked when the specified race is deleted or removed from this polls.
Parameters	`osid.id.Id`	`raceId`	the `Id` of the `Race` to monitor
Errors	NULL_ARGUMENT		`raceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.