OSID - osid.voting.PollsNotificationSession Service Interface Definition

Interface	osid.voting.PollsNotificationSession
Implements	`osid.OsidSession`
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	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	registerForNewPollsAncestors
Description	Registers for notification if an ancestor is added to the specified polls in the polls hierarchy. `PollsReceiver.newPollsAncestor()` is invoked when the specified polls experiences an addition in ancestry.
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	registerForNewPollsDescendants
Description	Registers for notification if a descendant is added to the specified polls in the polls hierarchy. `PollsReceiver.newPollsDescendant()` is invoked when the specified polls experiences an addition in descendants.
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	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	registerForDeletedPollsAncestors
Description	Registers for notification if an ancestor is removed from the specified polls in the polls hierarchy. `PollsReceiver.deletedPollsAncestor()` is invoked when the specified polls experiences a removal of an ancestor.
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	registerForDeletedPollsDescendants
Description	Registers for notification if a descendant is removed from fthe specified polls in the polls hierarchy. `PollsReceiver.deletedPollsDescendnant()` is invoked when the specified polls experiences a removal of one of its descdendents.
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.