OSID - osid.inventory.WarehouseNotificationSession Service Interface Definition

Interface	osid.inventory.WarehouseNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.inventory.InventoryManager`
Used By	`osid.inventory.InventoryProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Warehouses`. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this sess
Method	canRegisterForWarehouseNotifications
Description	Tests if this user can register for `Warehouse` 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	reliableWarehouseNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeWarehouseNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableWarehouseNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeWarehouseNotification
Description	Acknowledge a warehouse 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	registerForNewWarehouses
Description	Register for notifications of new warehouses. `WarehouseReceiver.newWarehouses()` is invoked when a new `Warehouse` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedWarehouses
Description	Registers for notification of updated warehouses. `WarehouseReceiver.changedWarehouses()` is invoked when a warehouse is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedWarehouse
Description	Registers for notification of an updated warehouse. `WarehouseReceiver.changedWarehouses()` is invoked when the specified warehouse is changed. S
Parameters	`osid.id.Id`	`warehouseId`	the Id of the `Warehouse` to monitor
Errors	NULL_ARGUMENT		`warehouseId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedWarehouses
Description	Registers for notification of deleted warehouses. `WarehouseReceiver.deletedWarehouses()` is invoked when a warehouse is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedWarehouse
Description	Registers for notification of a deleted warehouse. `WarehouseReceiver.deletedWarehouses()` is invoked when the specified warehouse is deleted.
Parameters	`osid.id.Id`	`warehouseId`	the Id of the `Warehouse` to monitor
Errors	NULL_ARGUMENT		`warehouseId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedWarehouseHierarchy
Description	Registers for notification of an updated warehouse hierarchy structure. `WarehouseReceiver.changedChildOfWarehouses()` is invoked when a node 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	registerForChangedWarehouseHierarchyForAncestors
Description	Registers for notification of an updated warehouse hierarchy structure. `WarehouseReceiver.changedChildOfWarehouses()` is invoked when a node experiences a change in its children.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse` node to monitor
Errors	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedWarehouseHierarchyForDescendants
Description	Registers for notification of an updated warehouse hierarchy structure. `WarehouseReceiver.changedChildOfWarehouses()` is invoked when a node experiences a change in its children.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse` node to monitor
Errors	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.