OSID - osid.resource.BinNotificationSession Service Interface Definition

Interface	osid.resource.BinNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.resource.ResourceManager`
Used By	`osid.resource.ResourceProxyManager`
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	reliableBinNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeBinNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableBinNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeBinNotification
Description	Acknowledge a bin 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	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	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	registerForChangedBinHierarchy
Description	Registers for notification of an updated bin hierarchy structure. `BinReceiver.changedChildOfBins()` 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	registerForChangedBinHierarchyForAncestors
Description	Registers for notification of an updated bin hierarchy structure. `BinReceiver.changedChildOfBins()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin` node 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	registerForChangedBinHierarchyForDescendants
Description	Registers for notification of an updated bin hierarchy structure. `BinReceiver.changedChildOfBins()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin` node 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.