OSID - osid.resource.BinNotificationSession Service Interface Definition

Interface	osid.resource.BinNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Bin` 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	canRegisterForBinNotifications
Description	Tests if this user can register for `Bin` 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	registerForNewBins
Description	Register for notifications of new bins. `BinReceiver.newBins()` is invoked when a new `Bin` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewBinAncestors
Description	Registers for notification if an ancestor is added to the specified bin in the bin hierarchy. `BinReceiver.newBinAncestor()` is invoked when the specified bin experiences an addition in ancestry.
Parameters	`osid.id.Id`	`binId`	the `Id` of the bin to monitor
Errors	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewBinDescendants
Description	Registers for notification if a descendant is added to the specified bin in the bin hierarchy. `BinReceiver.newBinDescendant()` is invoked when the specified bin experiences an addition in descendants.
Parameters	`osid.id.Id`	`binId`	the `Id` of the bin to monitor
Errors	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBins
Description	Registers for notification of updated bins. `BinReceiver.changedBins()` is invoked when a bin is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBin
Description	Registers for notification of an updated bin. `BinReceiver.changedBins()` is invoked when the specified bin is changed.
Parameters	`osid.id.Id`	`binId`	the Id of the Bin to monitor
Errors	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBins
Description	Registers for notification of deleted bins. `BinReceiver.deletedBins()` is invoked when a bin is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBin
Description	Registers for notification of a deleted bin. `BinReceiver.deletedBins()` is invoked when the specified bin is deleted.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin` to monitor
Errors	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBinAncestors
Description	Registers for notification if an ancestor is removed from the specified bin in the bin hierarchy. `BinReceiver.deletedBinAncestor()` is invoked when the specified bin experiences a removal of an ancestor.
Parameters	`osid.id.Id`	`binId`	the `Id` of the bin to monitor
Errors	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBinDescendants
Description	Registers for notification if a descendant is removed from fthe specified bin in the bin hierarchy. `BinReceiver.deletedBinDescendnant()` is invoked when the specified bin experiences a removal of one of its descdendents.
Parameters	`osid.id.Id`	`binId`	the `Id` of the bin to monitor
Errors	NULL_ARGUMENT		`binId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.