OSID - osid.voting.BallotNotificationSession Service Interface Definition

Interface	osid.voting.BallotNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.voting.VotingManager`
Used By	`osid.voting.VotingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Ballot` objects in this `Polls`. This also includes existing ballots 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 `BallotLookupSession`.
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	canRegisterForBallotNotifications
Description	Tests if this user can register for `Ballot` 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 ballots 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	reliableBallotNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeBallotNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableBallotNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeBallotNotification
Description	Acknowledge a ballot 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	registerForNewBallots
Description	Register for notifications of new ballots. `BallotReceiver.newBallots()` is invoked when a new `Ballot` is appears in this polls.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBallots
Description	Registers for notification of updated ballots. `BallotReceiver.changedBallots()` is invoked when a ballot 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	registerForChangedBallot
Description	Registers for notification of an updated ballot. `BallotReceiver.changedBallots()` is invoked when the specified ballot 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	registerForDeletedBallots
Description	Registers for notification of deleted ballots. `BallotReceiver.deletedBallots()` is invoked when a ballot 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	registerForDeletedBallot
Description	Registers for notification of a deleted ballot. `BallotReceiver.deletedBallots()` is invoked when the specified ballot 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.