OSID - osid.provisioning.DistributorNotificationSession Service Interface Definition

Interface	osid.provisioning.DistributorNotificationSession
Implements	`osid.OsidSession`
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	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	registerForNewDistributorAncestors
Description	Registers for notification if an ancestor is added to the specified distributor in the distributor hierarchy. `DistributorReceiver.newDistributorAncestor()` is invoked when the specified distributor experiences an addition in ancestry.
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	registerForNewDistributorDescendants
Description	Registers for notification if a descendant is added to the specified distributor in the distributor hierarchy. `DistributorReceiver.newDistributorDescendant()` is invoked when the specified distributor experiences an addition in descendants.
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	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	registerForDeletedDistributorAncestors
Description	Registers for notification if an ancestor is removed from the specified distributor in the distributor hierarchy. `DistributorReceiver.deletedDistributorAncestor()` is invoked when the specified distributor experiences a removal of an ancestor.
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	registerForDeletedDistributorDescendants
Description	Registers for notification if a descendant is removed from fthe specified distributor in the distributor hierarchy. `DistributorReceiver.deletedDistributorDescednant()` is invoked when the specified distributor experiences a removal of one of its descdendents.
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.