OSID - osid.provisioning.DistributorNotificationSession Service Interface Definition

Interface	osid.provisioning.DistributorNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.provisioning.ProvisioningManager`
Used By	`osid.provisioning.ProvisioningProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Distributor` 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	canRegisterForDistributorNotifications
Description	Tests if this user can register for `Distributor` 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	reliableDistributorNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeDistributorNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableDistributorNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeDistributorNotification
Description	Acknowledge a distributor 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	registerForNewDistributors
Description	Register for notifications of new distributors. `DistributorReceiver.newDistributors()` is invoked when a new `Distributor` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDistributors
Description	Registers for notification of updated distributors. `DistributorReceiver.changedDistributors()` is invoked when a distributor is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDistributor
Description	Registers for notification of an updated distributor. `DistributorReceiver.changedDistributors()` is invoked when the specified distributor is changed.
Parameters	`osid.id.Id`	`distributorId`	the Id of the `Distributor` to monitor
Errors	NULL_ARGUMENT		`distributorId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDistributors
Description	Registers for notification of deleted distributors. `DistributorReceiver.deletedDistributors()` is invoked when a distributor is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDistributor
Description	Registers for notification of a deleted distributor. `DistributorReceiver.deletedDistributors()` is invoked when the specified distributor is deleted.
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor` to monitor
Errors	NULL_ARGUMENT		`distributorId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDistributorHierarchy
Description	Registers for notification of an updated distributor hierarchy structure. `DistributorReceiver.changedChildOfDistributors()` is invoked when the specified node or any of its descendants 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	registerForChangedDistributorHierarchyForAncestors
Description	Registers for notification of an updated distributor hierarchy structure. `DistributorReceiver.changedChildOfDistributors()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor` node to monitor
Errors	NULL_ARGUMENT		`distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDistributorHierarchyForDescendants
Description	Registers for notification of an updated distributor hierarchy structure. `DistributorReceiver.changedChildOfDistributors()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`distributorId`	the `Id` of the `Distributor` node to monitor
Errors	NULL_ARGUMENT		`distributorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.