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

Interface	osid.voting.rules.VoteEnablerNotificationSession
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 `VoteEnablers` in this `Polls` . This also includes existing vote enablers that may appear or disappear due to changes in the `Polls hierarch` y, 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 `VoteEnablerLookupSession` .
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	canRegisterForVoteEnablerNotifications
Description	Tests if this user can register for `VoteEnabler` 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 vote enablers 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	reliableVoteEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeVoteEnablerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableVoteEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeVoteEnablerNotification
Description	Acknowledge a vote enabler 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	registerForNewVoteEnablers
Description	Register for notifications of new vote enablers. `VoteEnablerReceiver.newVoteEnablers()` is invoked when a new `VoteEnabler` appears in this polls.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedVoteEnablers
Description	Register for notifications of updated vote enablers. `VoteEnablerReceiver.changedVoteEnablers()` is invoked when a `VoteEnabler` 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	registerForChangedVoteEnabler
Description	Register for notifications of an updated vote enabler. `VoteEnablerReceiver.changedVoteEnablers()` is invoked when the specified `VoteEnabler` in this polls is changed.
Parameters	`osid.id.Id`	`voteEnablerId`	the `Id` of the `VoteEnabler` to monitor
Errors	NULL_ARGUMENT		`voteEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedVoteEnablers
Description	Registers for notification of deleted vote enablers. `VoteEnablerReceiver.deletedVoteEnablers()` is invoked when a vote enabler 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	registerForDeletedVoteEnabler
Description	Registers for notification of a deleted vote enabler. `VoteEnablerReceiver.deletedVoteEnabler()` is invoked when the specified vote enabler is deleted or removed from this polls.
Parameters	`osid.id.Id`	`voteEnablerId`	the `Id` of the `VoteEnabler` to monitor
Errors	NULL_ARGUMENT		`voteEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.