OSID - osid.voting.PollsNotificationSession Service Interface Definition

Interface	osid.voting.PollsNotificationSession
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 `Polls` objects. 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.
Method	canRegisterForPollsNotifications
Description	Tests if this user can register for `Polls` 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	reliablePollsNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgePollsNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliablePollsNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgePollsNotification
Description	Acknowledge a polls 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	registerForNewPolls
Description	Register for notifications of new polls. `PollsReceiver.newPolls()` is invoked when a new `Polls` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPolls
Description	Registers for notification of updated polls. `PollsReceiver.changedPolls()` is invoked when a polls is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPolls
Description	Registers for notification of an updated polls. `PollsReceiver.changedPolls()` is invoked when the specified polls is changed.
Parameters	`osid.id.Id`	`pollsId`	the Id of the Polls to monitor
Errors	NULL_ARGUMENT		`pollsId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPolls
Description	Registers for notification of deleted polls. `PollsReceiver.deletedPolls()` is invoked when a polls is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPolls
Description	Registers for notification of a deleted polls. `PollsReceiver.deletedPolls()` is invoked when the specified polls is deleted.
Parameters	`osid.id.Id`	`pollsId`	the `Id` of the `Polls` to monitor
Errors	NULL_ARGUMENT		`pollsId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPollsHierarchy
Description	Registers for notification of an updated polls hierarchy structure. `PollsReceiver.changedChildOfPolls()` is invoked when a node experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPollsHierarchyForAncestors
Description	Registers for notification of an updated polls hierarchy structure. `PollsReceiver.changedChildOfPolls()` is invoked when a node experiences a change in its children.
Parameters	`osid.id.Id`	`pollsId`	the `Id` of the `Polls` node to monitor
Errors	NULL_ARGUMENT		`pollsId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPollsHierarchyForDescendants
Description	Registers for notification of an updated polls hierarchy structure. `PollsReceiver.changedChildOfPolls()` is invoked when a node experiences a change in its children.
Parameters	`osid.id.Id`	`pollsId`	the `Id` of the `Polls` node to monitor
Errors	NULL_ARGUMENT		`pollsId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.