OSID - osid.inventory.StockNotificationSession Service Interface Definition

Interface	osid.inventory.StockNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Stock` objects in this `Warehouse.` This also includes existing stocks that may appear or disappear due to changes in the `Warehouse` hierarchy, 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. The two views defined in this session correspond to the views in the `StockLookupSession.`
Method	getWarehouseId
Description	Gets the `Warehouse` `Id` associated with this session.
Return	`osid.id.Id`		the `Warehouse Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouse
Description	Gets the `Warehouse` associated with this session.
Return	`osid.inventory.Warehouse`		the warehouse
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForStockNotifications
Description	Tests if this user can register for `Stock` 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	useFederatedWarehouseView
Description	Federates the view for methods in this session. A federated view will include stocks in catalogs which are children of this catalog in the warehouse hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedWarehouseView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this warehouse only.
Compliance	`mandatory`		This method is must be implemented.
Method	registerForNewStocks
Description	Register for notifications of new stocks. `StockReceiver.newStocks()` is invoked when a new `Stock` appears in this warehouse.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewStockAncestors
Description	Registers for notification if an ancestor is added to the specified stock in the stock hierarchy. `StockReceiver.newAncestorStock()` is invoked when the specified stock experiences an addition in ancestry.
Parameters	`osid.id.Id`	`stockId`	the `Id` of the stock to monitor
Errors	NULL_ARGUMENT		`stockId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewStockDescendants
Description	Registers for notification if a descendant is added to the specified stock in the stock hierarchy. `StockReceiver.newStockDescendant()` is invoked when the specified stock experiences an addition in descendants.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the stock to monitor
Errors	NULL_ARGUMENT		`stockId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedStocks
Description	Registers for notification of updated stocks. `StockReceiver.changedStocks()` is invoked when a stock in this warehouse is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedStock
Description	Registers for notification of an updated stock. `StockReceiver.changedStocks()` is invoked when the specified stock in this warehouse is changed.
Parameters	`osid.id.Id`	`stockId`	the `Id` of the `Stock` to monitor
Errors	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedStocks
Description	Registers for notification of deleted stocks. `StockReceiver.deletedStocks()` is invoked when a stock is deleted or removed from this warehouse.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedStock
Description	Registers for notification of a deleted stock. `StockReceiver.deletedStocks()` is invoked when the specified stock is deleted or removed from this warehouse.
Parameters	`osid.id.Id`	`stockId`	the `Id` of the `Stock` to monitor
Errors	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedStockAncestors
Description	Registers for notification if an ancestor is removed from the specified stock in the stock hierarchy. `StockReceiver.newAncestorStock()` is invoked when the specified stock experiences a removal in ancestry.
Parameters	`osid.id.Id`	`stockId`	the `Id` of the stock to monitor
Errors	NULL_ARGUMENT		`stockId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedStockDescendants
Description	Registers for notification if a descendant is removed from the specified stock in the stock hierarchy. `StockReceiver.newStockDescendant()` is invoked when the specified stock experiences a removal in descendants.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the stock to monitor
Errors	NULL_ARGUMENT		`stockId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.