OSID - osid.inventory.InventoryManager Service Interface Definition

Interface	osid.inventory.InventoryManager
Implements	`osid.OsidManager`
Implements	`osid.inventory.InventoryProfile`
Description	The inventory manager provides access to inventory sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `ItemLookupSession:` a session to retrieve items `ItemQuerySession:` a session to query items `ItemSearchSession:` a session to search for items `ItemAdminSession:` a session to create and delete items `ItemNotificationSession:` a session to receive notifications pertaining to item changes `ItemWarehouseSession:` a session to look up item to warehouse mappings `ItemWarehouseAssignmentSession:` a session to manage item to warehouse mappings `ItemSmartWarehouseSession:` a session to manage dynamic warehouses of items `StockLookupSession:` a session to retrieve stocks `StockQuerySession:` a session to query stocks `StockSearchSession:` a session to search for stocks `StockAdminSession:` a session to create and delete stocks `StockNotificationSession:` a session to receive notifications pertaining to stock changes `StockWarehouseSession:` a session to look up stock to warehouse mappings `StockWarehouseSession:` a session to look up stock to warehouse mappings `StockWarehouseAssignmentSession:` a session to manage stock to warehouse mappings `StockSmartWarehouseSession:` a session to manage dynamic warehouses of stocks `StockHierarchySession:` a session to traverse a hierarchy of stocks `StockHierarchyDesignSession:` a session to manage a stock hierarchy `ModelLookupSession:` a session to retrieve models `ModelQuerySession:` a session to query models `ModelSearchSession:` a session to search for models `ModelAdminSession:` a session to create and delete models `ModelNotificationSession:` a session to receive notifications pertaining to model changes `ModelWarehouseSession:` a session to look up model to warehouse mappings `ModelWarehouseSession:` a session to look up model to warehouse mappings `ModelWarehouseAssignmentSession:` a session to manage model to warehouse mappings `ModelSmartWarehouseSession:` a session to manage dynamic warehouses of models `InventoryLookupSession:` a session to retrieve inventories `InventoryLookupSession:` a session to query inventories `InventorySearchSession:` a session to search for inventories `InventoryAdminSession:` a session to create and delete inventories `InventoryNotificationSession:` a session to receive notifications pertaining to inventory changes `InventoryWarehouseSession:` a session to look up inventory to warehouse mappings `InventoryWarehouseAssignmentSession:` a session to manage inventory to warehouse mappings `InventorySmartWarehouseAssignmentSession:` a session to manage dynamic warehouses of inventories `WarehouseLookupSession:` a session to retrieve warehouses `WarehouseQuerySession:` a session to query warehouses `WarehousesearchSession:` a session to search for warehouses `WarehouseAdminSession:` a session to create and delete warehouses `WarehouseNotificationSession:` a session to receive notifications pertaining to warehouse changes `WarehouseHierarchySession:` a session to traverse a hierarchy of warehouses `WarehouseHierarchyDesignSession:` a session to manage a warehouse hierarchy
Method	getItemLookupSession
Description	Gets the `OsidSession` associated with the item lookup service.
Return	`osid.inventory.ItemLookupSession`		an `ItemSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsItemLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemLookup()` is `true.`
Method	getItemLookupSessionForWarehouse
Description	Gets the `OsidSession` associated with the item lookup service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the warehouse
Return	`osid.inventory.ItemLookupSession`		an `ItemLookupSession`
Errors	NOT_FOUND		no `Warehouse` found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsItemLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemLookup()` and `supportsVisibleFederation()` are `true`
Method	getItemQuerySession
Description	Gets the `OsidSession` associated with the item query service.
Return	`osid.inventory.ItemQuerySession`		an `ItemQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsItemQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemQuery()` is `true.`
Method	getItemQuerySessionForWarehouse
Description	Gets the `OsidSession` associated with the item query service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.ItemQuerySession`		an `ItemQuerySession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsItemQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemQuery()` and `supportsVisibleFederation()` are `true`
Method	getItemSearchSession
Description	Gets the `OsidSession` associated with the item search service.
Return	`osid.inventory.ItemSearchSession`		an `ItemSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsItemSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemSearch()` is `true.`
Method	getItemSearchSessionForWarehouse
Description	Gets the `OsidSession` associated with the item search service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.ItemSearchSession`		an `ItemSearchSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsItemSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemSearch()` and `supportsVisibleFederation()` are `true`
Method	getItemAdminSession
Description	Gets the `OsidSession` associated with the item administration service.
Return	`osid.inventory.ItemAdminSession`		an `ItemAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsItemAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemAdmin()` is `true.`
Method	getItemAdminSessionForWarehouse
Description	Gets the `OsidSession` associated with the item administration service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.ItemAdminSession`		an `ItemAdminSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsItemAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemAdmin()` and `supportsVisibleFederation()` are `true`
Method	getItemNotificationSession
Description	Gets the `OsidSession` associated with the item notification service.
Parameters	`osid.inventory.ItemReceiver`	`itemReceiver`	the notification callback
Return	`osid.inventory.ItemNotificationSession`		an `ItemNotificationSession`
Errors	NULL_ARGUMENT		`itemReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsItemNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemNotification()` is `true.`
Method	getItemNotificationSessionForWarehouse
Description	Gets the `OsidSession` associated with the item notification service for the given warehouse.
Parameters	`osid.inventory.ItemReceiver`	`itemReceiver`	the notification callback
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.ItemNotificationSession`		an `ItemNotificationSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`itemReceiver` or `warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsItemNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemNotification()` and `supportsVisibleFederation()` are `true`
Method	getItemWarehouseSession
Description	Gets the `OsidSession` to lookup item/catalog mappings.
Return	`osid.inventory.ItemWarehouseSession`		an `ItemWarehouseSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsItemWarehouse()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemWarehouse()` is `true.`
Method	getItemWarehouseAssignmentSession
Description	Gets the `OsidSession` associated with assigning items to warehouses.
Return	`osid.inventory.ItemWarehouseAssignmentSession`		an `ItemWarehouseAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsItemWarehouseAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemWarehouseAssignment()` is `true.`
Method	getItemSmartWarehouseSession
Description	Gets the `OsidSession` associated with the item smart warehouse service.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.ItemSmartWarehouseSession`		an `ItemSmartWarehouseSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsItemSmartWarehouse()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsItemSmartWarehouse()` and `supportsVisibleFederation()` are `true`
Method	getStockLookupSession
Description	Gets the `OsidSession` associated with the stock lookup service.
Return	`osid.inventory.StockLookupSession`		a `StockSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStockLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockLookup()` is `true.`
Method	getStockLookupSessionForWarehouse
Description	Gets the `OsidSession` associated with the stock lookup service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the warehouse
Return	`osid.inventory.StockLookupSession`		a `StockLookupSession`
Errors	NOT_FOUND		no `Warehouse` found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStockLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockLookup()` and `supportsVisibleFederation()` are `true`
Method	getStockQuerySession
Description	Gets the `OsidSession` associated with the stock query service.
Return	`osid.inventory.StockQuerySession`		a `StockQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStockQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockQuery()` is `true.`
Method	getStockQuerySessionForWarehouse
Description	Gets the `OsidSession` associated with the stock query service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.StockQuerySession`		a `StockQuerySession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStockQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockQuery()` and `supportsVisibleFederation()` are `true`
Method	getStockSearchSession
Description	Gets the `OsidSession` associated with the stock search service.
Return	`osid.inventory.StockSearchSession`		a `StockSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStockSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockSearch()` is `true.`
Method	getStockSearchSessionForWarehouse
Description	Gets the `OsidSession` associated with the stock search service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.StockSearchSession`		a `StockSearchSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStockSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockSearch()` and `supportsVisibleFederation()` are `true`
Method	getStockAdminSession
Description	Gets the `OsidSession` associated with the stock administration service.
Return	`osid.inventory.StockAdminSession`		a `StockAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStockAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockAdmin()` is `true.`
Method	getStockAdminSessionForWarehouse
Description	Gets the `OsidSession` associated with the stock administration service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.StockAdminSession`		a `StockAdminSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStockAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockAdmin()` and `supportsVisibleFederation()` are `true`
Method	getStockNotificationSession
Description	Gets the `OsidSession` associated with the stock notification service.
Parameters	`osid.inventory.StockReceiver`	`stockReceiver`	the notification callback
Return	`osid.inventory.StockNotificationSession`		a `StockNotificationSession`
Errors	NULL_ARGUMENT		`stockReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStockNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockNotification()` is `true.`
Method	getStockNotificationSessionForWarehouse
Description	Gets the `OsidSession` associated with the stock notification service for the given warehouse.
Parameters	`osid.inventory.StockReceiver`	`stockReceiver`	the notification callback
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.StockNotificationSession`		a `StockNotificationSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`stockReceiver` or `warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStockNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockNotification()` and `supportsVisibleFederation()` are `true`
Method	getStockWarehouseSession
Description	Gets the `OsidSession` to lookup stock/catalog mappings.
Return	`osid.inventory.StockWarehouseSession`		a `StockWarehouseSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStockWarehouse()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockWarehouse()` is `true.`
Method	getStockWarehouseAssignmentSession
Description	Gets the `OsidSession` associated with assigning stocks to warehouses.
Return	`osid.inventory.StockWarehouseAssignmentSession`		a `StockWarehouseAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStockWarehouseAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockWarehouseAssignment()` is `true.`
Method	getStockSmartWarehouseSession
Description	Gets the `OsidSession` associated with the stock smart warehouse service.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.StockSmartWarehouseSession`		a `StockSmartWarehouseSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStockSmartWarehouse()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockSmartWarehouse()` and `supportsVisibleFederation()` are `true`
Method	getStockHierarchySession
Description	Gets the stock hierarchy traversal session.
Return	`osid.inventory.StockHierarchySession`		a `StockHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStockHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockHierarchy()` is `true.`
Method	getStockHierarchySessionForWarehouse
Description	Gets the stock hierarchy traversal session for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.StockHierarchySession`		a `StockHierarchySession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStockHierarchy()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockHierarchy()` and `supportsVisibleFederation()` are `true`
Method	getStockHierarchyDesignSession
Description	Gets the stock hierarchy design session.
Return	`osid.inventory.StockHierarchyDesignSession`		a `StockHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsStockHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockHierarchyDesign()` is `true.`
Method	getStockHierarchyDesignSessionForWarehouse
Description	Gets the stock hierarchy design session for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.StockHierarchyDesignSession`		a `StockHierarchyDesignSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsStockHierarchyDesign()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStockHierarchyDesign()` and `supportsVisibleFederation()` are `true`
Method	getModelLookupSession
Description	Gets the `OsidSession` associated with the model lookup service.
Return	`osid.inventory.ModelLookupSession`		a `ModelSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsModelLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelLookup()` is `true.`
Method	getModelLookupSessionForWarehouse
Description	Gets the `OsidSession` associated with the model lookup service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the warehouse
Return	`osid.inventory.ModelLookupSession`		a `ModelLookupSession`
Errors	NOT_FOUND		no `Warehouse` found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsModelLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelLookup()` and `supportsVisibleFederation()` are `true`
Method	getModelQuerySession
Description	Gets the `OsidSession` associated with the model query service.
Return	`osid.inventory.ModelQuerySession`		a `ModelQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsModelQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelQuery()` is `true.`
Method	getModelQuerySessionForWarehouse
Description	Gets the `OsidSession` associated with the model query service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.ModelQuerySession`		a `ModelQuerySession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsModelQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelQuery()` and `supportsVisibleFederation()` are `true`
Method	getModelSearchSession
Description	Gets the `OsidSession` associated with the model search service.
Return	`osid.inventory.ModelSearchSession`		a `ModelSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsModelSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelSearch()` is `true.`
Method	getModelSearchSessionForWarehouse
Description	Gets the `OsidSession` associated with the model search service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.ModelSearchSession`		a `ModelSearchSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsModelSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelSearch()` and `supportsVisibleFederation()` are `true`
Method	getModelAdminSession
Description	Gets the `OsidSession` associated with the model administration service.
Return	`osid.inventory.ModelAdminSession`		a `ModelAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsModelAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelAdmin()` is `true.`
Method	getModelAdminSessionForWarehouse
Description	Gets the `OsidSession` associated with the model administration service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.ModelAdminSession`		a `ModelAdminSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsModelAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelAdmin()` and `supportsVisibleFederation()` are `true`
Method	getModelNotificationSession
Description	Gets the `OsidSession` associated with the model notification service.
Parameters	`osid.inventory.ModelReceiver`	`modelReceiver`	the notification callback
Return	`osid.inventory.ModelNotificationSession`		a `ModelNotificationSession`
Errors	NULL_ARGUMENT		`modelReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsModelNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelNotification()` is `true.`
Method	getModelNotificationSessionForWarehouse
Description	Gets the `OsidSession` associated with the model notification service for the given warehouse.
Parameters	`osid.inventory.ModelReceiver`	`modelReceiver`	the notification callback
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.ModelNotificationSession`		a `ModelNotificationSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`modelReceiver` or `warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsModelNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelNotification()` and `supportsVisibleFederation()` are `true`
Method	getModelWarehouseSession
Description	Gets the `OsidSession` to lookup model/catalog mappings.
Return	`osid.inventory.ModelWarehouseSession`		a `ModelWarehouseSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsModelWarehouse()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelWarehouse()` is `true.`
Method	getModelWarehouseAssignmentSession
Description	Gets the `OsidSession` associated with assigning models to warehouses.
Return	`osid.inventory.ModelWarehouseAssignmentSession`		a `ModelWarehouseAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsModelWarehouseAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelWarehouseAssignment()` is `true.`
Method	getModelSmartWarehouseSession
Description	Gets the `OsidSession` associated with the model smart warehouse service.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.ModelSmartWarehouseSession`		a `ModelSmartWarehouseSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsModelSmartWarehouse()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsModelSmartWarehouse()` and `supportsVisibleFederation()` are `true`
Method	getInventoryLookupSession
Description	Gets the `OsidSession` associated with the inventory lookup service.
Return	`osid.inventory.InventoryLookupSession`		an `InventoryLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInventoryLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventoryLookup()` is `true.`
Method	getInventoryLookupSessionForWarehouse
Description	Gets the `OsidSession` associated with the inventory lookup service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.InventoryLookupSession`		an `InventoryLookupSession`
Errors	NOT_FOUND		no `Warehouse` found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsInventoryLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventoryLookup()` and `supportsVisibleFederation()` are `true`
Method	getInventoryQuerySession
Description	Gets the `OsidSession` associated with the inventory query service.
Return	`osid.inventory.InventoryQuerySession`		an `InventoryQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInventoryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventoryQuery()` is `true.`
Method	getInventoryQuerySessionForWarehouse
Description	Gets the `OsidSession` associated with the inventory query service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.InventoryQuerySession`		an `InventoryQuerySession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsInventoryQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventoryQuery()` and `supportsVisibleFederation()` are `true`
Method	getInventorySearchSession
Description	Gets the `OsidSession` associated with the inventory search service.
Return	`osid.inventory.InventorySearchSession`		an `InventorySearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInventorySearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventorySearch()` is `true.`
Method	getInventorySearchSessionForWarehouse
Description	Gets the `OsidSession` associated with the inventory search service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.InventorySearchSession`		an `InventorySearchSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsInventorySearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventorySearch()` and `supportsVisibleFederation()` are `true`
Method	getInventoryAdminSession
Description	Gets the `OsidSession` associated with the inventory administration service.
Return	`osid.inventory.InventoryAdminSession`		an `InventoryAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInventoryAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventoryAdmin()` is `true.`
Method	getInventoryAdminSessionForWarehouse
Description	Gets the `OsidSession` associated with the inventory administration service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.InventoryAdminSession`		an `InventoryAdminSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsInventoryAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventoryAdmin()` and `supportsVisibleFederation()` are `true`
Method	getInventoryNotificationSession
Description	Gets the `OsidSession` associated with the inventory notification service.
Parameters	`osid.inventory.InventoryReceiver`	`inventoryReceiver`	the notification callback
Return	`osid.inventory.InventoryNotificationSession`		an `InventoryNotificationSession`
Errors	NULL_ARGUMENT		`inventoryReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsInventoryNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventoryNotification()` is `true.`
Method	getInventoryNotificationSessionForWarehouse
Description	Gets the `OsidSession` associated with the inventory notification service for the given warehouse.
Parameters	`osid.inventory.InventoryReceiver`	`inventoryReceiver`	the notification callback
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.InventoryNotificationSession`		an `InventoryNotificationSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`inventoryReceiver` or `warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsInventoryNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventoryNotification()` and `supportsVisibleFederation()` are `true`
Method	getInventoryWarehouseSession
Description	Gets the `OsidSession` to lookup inventory/catalog mappings.
Return	`osid.inventory.InventoryWarehouseSession`		an `InventoryWarehouseSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInventoryWarehouse()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventoryWarehouse()` is `true.`
Method	getInventoryWarehouseAssignmentSession
Description	Gets the `OsidSession` associated with assigning inventories to warehouses.
Return	`osid.inventory.InventoryWarehouseAssignmentSession`		an `InventoryWarehouseAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInventoryWarehouseAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventoryWarehouseAssignment()` is `true.`
Method	getInventorySmartWarehouseSession
Description	Gets the `OsidSession` associated with the inventory smart warehouse service.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.InventorySmartWarehouseSession`		an `InventorySmartWarehouseSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsInventorySmartWarehouse()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventorySmartWarehouse()` and `supportsVisibleFederation()` are `true`
Method	getWarehouseLookupSession
Description	Gets the `OsidSession` associated with the warehouse lookup service.
Return	`osid.inventory.WarehouseLookupSession`		a `WarehouseLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsWarehouseLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWarehouseLookup()` is `true.`
Method	getWarehouseQuerySession
Description	Gets the `OsidSession` associated with the warehouse query service.
Return	`osid.inventory.WarehouseQuerySession`		a `WarehouseQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsWarehouseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWarehouseQuery()` is `true.`
Method	getWarehouseSearchSession
Description	Gets the `OsidSession` associated with the warehouse search service.
Return	`osid.inventory.WarehouseSearchSession`		a `WarehouseSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsWarehouseSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWarehouseSearch()` is `true.`
Method	getWarehouseAdminSession
Description	Gets the `OsidSession` associated with the warehouse administrative service.
Return	`osid.inventory.WarehouseAdminSession`		a `WarehouseAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsWarehouseAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWarehouseAdmin()` is `true.`
Method	getWarehouseNotificationSession
Description	Gets the `OsidSession` associated with the warehouse notification service.
Parameters	`osid.inventory.WarehouseReceiver`	`warehouseReceiver`	the notification callback
Return	`osid.inventory.WarehouseNotificationSession`		a `WarehouseNotificationSession`
Errors	NULL_ARGUMENT		`warehouseReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsWarehouseNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWarehouseNotification()` is `true.`
Method	getWarehouseHierarchySession
Description	Gets the `OsidSession` associated with the warehouse hierarchy service.
Return	`osid.inventory.WarehouseHierarchySession`		a `WarehouseHierarchySession` for warehouses
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsWarehouseHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWarehouseHierarchy()` is `true.`
Method	getWarehouseHierarchyDesignSession
Description	Gets the `OsidSession` associated with the warehouse hierarchy design service.
Return	`osid.inventory.WarehouseHierarchyDesignSession`		a `HierarchyDesignSession` for warehouses
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsWarehouseHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsWarehouseHierarchyDesign()` is `true.`
Method	getInventoryBatchManager
Description	Gets the `InventoryBatchManager.`
Return	`osid.inventory.batch.InventoryBatchManager`		a `InventoryBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInventoryBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventoryBatch()` is `true.`
Method	getInventoryShipmentManager
Description	Gets the `InventoryShipmentManager.`
Return	`osid.inventory.shipment.InventoryShipmentManager`		a `InventoryShipmentManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInventoryShipment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventoryShipment()` is `true.`