OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.InventoryProxyManager
Implementsosid.OsidProxyManager
osid.inventory.InventoryProfile
Description

The inventory manager provides access to inventory sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy interface for passing information from server environments. 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
MethodgetItemLookupSession
Description

Gets the OsidSession associated with the item lookup service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.ItemLookupSessionan ItemLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemLookup() is false
ComplianceoptionalThis method must be implemented if supportsItemLookup() is true.
MethodgetItemLookupSessionForWarehouse
Description

Gets the OsidSession associated with the item lookup service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.ItemLookupSessionan ItemLookupSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsItemLookup() and supportsVisibleFederation() are true
MethodgetItemQuerySession
Description

Gets the OsidSession associated with the item query service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.ItemQuerySessionan ItemQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemQuery() is false
ComplianceoptionalThis method must be implemented if supportsItemQuery() is true.
MethodgetItemQuerySessionForWarehouse
Description

Gets the OsidSession associated with the item query service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.ItemQuerySessionan ItemQuerySession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsItemQuery() and supportsVisibleFederation() are true
MethodgetItemSearchSession
Description

Gets the OsidSession associated with the item search service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.ItemSearchSessionan ItemSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemSearch() is false
ComplianceoptionalThis method must be implemented if supportsItemSearch() is true.
MethodgetItemSearchSessionForWarehouse
Description

Gets the OsidSession associated with the item search service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.ItemSearchSessionan ItemSearchSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsItemSearch() and supportsVisibleFederation() are true
MethodgetItemAdminSession
Description

Gets the OsidSession associated with the item administration service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.ItemAdminSessionan ItemAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemAdmin() is false
ComplianceoptionalThis method must be implemented if supportsItemAdmin() is true.
MethodgetItemAdminSessionForWarehouse
Description

Gets the OsidSession associated with the item administration service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.ItemAdminSessionan ItemAdminSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsItemAdmin() and supportsVisibleFederation() are true
MethodgetItemNotificationSession
Description

Gets the OsidSession associated with the item notification service.

Parametersosid.inventory.ItemReceiveritemReceiverthe notification callback
osid.proxy.Proxyproxyproxy
Returnosid.inventory.ItemNotificationSessionan ItemNotificationSession
ErrorsNULL_ARGUMENT itemReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemNotification() is false
ComplianceoptionalThis method must be implemented if supportsItemNotification() is true.
MethodgetItemNotificationSessionForWarehouse
Description

Gets the OsidSession associated with the item notification service for the given warehouse.

Parametersosid.inventory.ItemReceiveritemReceiverthe notification callback
osid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.ItemNotificationSessionan ItemNotificationSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT itemReceiver, warehouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsItemNotification() and supportsVisibleFederation() are true
MethodgetItemWarehouseSession
Description

Gets the OsidSession to lookup item/catalog mappings.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.ItemWarehouseSessionan ItemCatalogSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemCatalog() is false
ComplianceoptionalThis method must be implemented if supportsItemCatalog() is true.
MethodgetItemWarehouseAssignmentSession
Description

Gets the OsidSession associated with assigning items to warehouses.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.ItemWarehouseAssignmentSessionan ItemCatalogAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemCatalogAssignment() is false
ComplianceoptionalThis method must be implemented if supportsItemCatalogAssignment() is true.
MethodgetItemSmartWarehouseSession
Description

Gets the OsidSession associated with the item smart warehouse service.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.ItemSmartWarehouseSessionan ItemSmartWarehouseSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT warehouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsItemSmartWarehouse() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsItemSmartWarehouse() and supportsVisibleFederation() are true
MethodgetStockLookupSession
Description

Gets the OsidSession associated with the stock lookup service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.StockLookupSessiona StockSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockLookup() is false
ComplianceoptionalThis method must be implemented if supportsStockLookup() is true.
MethodgetStockLookupSessionForWarehouse
Description

Gets the OsidSession associated with the stock lookup service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.StockLookupSessiona StockLookupSession
ErrorsNOT_FOUNDno Warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStockLookup() and supportsVisibleFederation() are true
MethodgetStockQuerySession
Description

Gets the OsidSession associated with the stock query service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.StockQuerySessiona StockQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockQuery() is false
ComplianceoptionalThis method must be implemented if supportsStockQuery() is true.
MethodgetStockQuerySessionForWarehouse
Description

Gets the OsidSession associated with the stock query service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.StockQuerySessiona StockQuerySession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStockQuery() and supportsVisibleFederation() are true
MethodgetStockSearchSession
Description

Gets the OsidSession associated with the stock search service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.StockSearchSessiona StockSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockSearch() is false
ComplianceoptionalThis method must be implemented if supportsStockSearch() is true.
MethodgetStockSearchSessionForWarehouse
Description

Gets the OsidSession associated with the stock search service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.StockSearchSessiona StockSearchSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStockSearch() and supportsVisibleFederation() are true
MethodgetStockAdminSession
Description

Gets the OsidSession associated with the stock administration service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.StockAdminSessiona StockAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockAdmin() is false
ComplianceoptionalThis method must be implemented if supportsStockAdmin() is true.
MethodgetStockAdminSessionForWarehouse
Description

Gets the OsidSession associated with the stock administration service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.StockAdminSessiona StockAdminSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStockAdmin() and supportsVisibleFederation() are true
MethodgetStockNotificationSession
Description

Gets the OsidSession associated with the stock notification service.

Parametersosid.inventory.StockReceiverstockReceiverthe notification callback
osid.proxy.Proxyproxyproxy
Returnosid.inventory.StockNotificationSessiona StockNotificationSession
ErrorsNULL_ARGUMENT stockReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockNotification() is false
ComplianceoptionalThis method must be implemented if supportsStockNotification() is true.
MethodgetStockNotificationSessionForWarehouse
Description

Gets the OsidSession associated with the stock notification service for the given warehouse.

Parametersosid.inventory.StockReceiverstockReceiverthe notification callback
osid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.StockNotificationSessiona StockNotificationSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT stockReceiver, warehouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStockNotification() and supportsVisibleFederation() are true
MethodgetStockWarehouseSession
Description

Gets the OsidSession to lookup stock/catalog mappings.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.StockWarehouseSessiona StockWarehouseSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockWarehouse() is false
ComplianceoptionalThis method must be implemented if supportsStockWarehouse() is true.
MethodgetStockWarehouseAssignmentSession
Description

Gets the OsidSession associated with assigning stocks to warehouses.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.StockWarehouseAssignmentSessiona StockWarehouseAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockWarehouseAssignment() is false
ComplianceoptionalThis method must be implemented if supportsStockWarehouseAssignment() is true.
MethodgetStockSmartWarehouseSession
Description

Gets the OsidSession associated with the stock smart warehouse service.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.StockSmartWarehouseSessiona StockSmartWarehouseSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT warehouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockSmartWarehouse() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStockSmartWarehouse() and supportsVisibleFederation() are true
MethodgetStockHierarchySession
Description

Gets the stock hierarchy traversal session.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.StockHierarchySessiona StockHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsStockHierarchy() is true.
MethodgetStockHierarchySessionForWarehouse
Description

Gets the stock hierarchy traversal session for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.StockHierarchySessiona StockHierarchySession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT warehouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockHierarchy() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStockHierarchy() and supportsVisibleFederation() are true
MethodgetStockHierarchyDesignSession
Description

Gets the stock hierarchy design session.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.StockHierarchyDesignSessiona StockHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsStockHierarchyDesign() is true.
MethodgetStockHierarchyDesignSessionForWarehouse
Description

Gets the stock hierarchy design session for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.StockHierarchyDesignSessiona StockHierarchyDesignSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT warehouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsStockHierarchyDesign() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsStockHierarchyDesign() and supportsVisibleFederation() are true
MethodgetModelLookupSession
Description

Gets the OsidSession associated with the model lookup service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.ModelLookupSessiona ModelSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModelLookup() is false
ComplianceoptionalThis method must be implemented if supportsModelLookup() is true.
MethodgetModelLookupSessionForWarehouse
Description

Gets the OsidSession associated with the model lookup service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.ModelLookupSessiona ModelLookupSession
ErrorsNOT_FOUNDno Warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModelLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsModelLookup() and supportsVisibleFederation() are true
MethodgetModelQuerySession
Description

Gets the OsidSession associated with the model query service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.ModelQuerySessiona ModelQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModelQuery() is false
ComplianceoptionalThis method must be implemented if supportsModelQuery() is true.
MethodgetModelQuerySessionForWarehouse
Description

Gets the OsidSession associated with the model query service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.ModelQuerySessiona ModelQuerySession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModelQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsModelQuery() and supportsVisibleFederation() are true
MethodgetModelSearchSession
Description

Gets the OsidSession associated with the model search service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.ModelSearchSessiona ModelSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModelSearch() is false
ComplianceoptionalThis method must be implemented if supportsModelSearch() is true.
MethodgetModelSearchSessionForWarehouse
Description

Gets the OsidSession associated with the model search service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.ModelSearchSessiona ModelSearchSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModelSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsModelSearch() and supportsVisibleFederation() are true
MethodgetModelAdminSession
Description

Gets the OsidSession associated with the model administration service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.ModelAdminSessiona ModelAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModelAdmin() is false
ComplianceoptionalThis method must be implemented if supportsModelAdmin() is true.
MethodgetModelAdminSessionForWarehouse
Description

Gets the OsidSession associated with the model administration service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.ModelAdminSessiona ModelAdminSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModelAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsModelAdmin() and supportsVisibleFederation() are true
MethodgetModelNotificationSession
Description

Gets the OsidSession associated with the model notification service.

Parametersosid.inventory.ModelReceivermodelReceiverthe notification callback
osid.proxy.Proxyproxyproxy
Returnosid.inventory.ModelNotificationSessiona ModelNotificationSession
ErrorsNULL_ARGUMENT modelReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModelNotification() is false
ComplianceoptionalThis method must be implemented if supportsModelNotification() is true.
MethodgetModelNotificationSessionForWarehouse
Description

Gets the OsidSession associated with the model notification service for the given warehouse.

Parametersosid.inventory.ModelReceivermodelReceiverthe notification callback
osid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.ModelNotificationSessiona ModelNotificationSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT modelReceiver, warehouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModelNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsModelNotification() and supportsVisibleFederation() are true
MethodgetModelWarehouseSession
Description

Gets the OsidSession to lookup model/catalog mappings.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.ModelWarehouseSessiona ModelWarehouseSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModelWarehouse() is false
ComplianceoptionalThis method must be implemented if supportsModelWarehouse() is true.
MethodgetModelWarehouseAssignmentSession
Description

Gets the OsidSession associated with assigning models to warehouses.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.ModelWarehouseAssignmentSessiona ModelWarehouseAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModelWarehouseAssignment() is false
ComplianceoptionalThis method must be implemented if supportsModelWarehouseAssignment() is true.
MethodgetModelSmartWarehouseSession
Description

Gets the OsidSession associated with the model smart warehouse service.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.ModelSmartWarehouseSessiona ModelSmartWarehouseSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT warehouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsModelSmartWarehouse() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsModelSmartWarehouse() and supportsVisibleFederation() are true
MethodgetInventoryLookupSession
Description

Gets the OsidSession associated with the inventory lookup service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.InventoryLookupSessiona InventoryLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventoryLookup() is false
ComplianceoptionalThis method must be implemented if supportsInventoryLookup() is true.
MethodgetInventoryLookupSessionForWarehouse
Description

Gets the OsidSession associated with the inventory lookup service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.InventoryLookupSessiona InventoryLookupSession
ErrorsNOT_FOUNDno Warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventoryLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInventoryLookup() and supportsVisibleFederation() are true
MethodgetInventoryQuerySession
Description

Gets the OsidSession associated with the inventory query service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.InventoryQuerySessionan InventoryQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventoryQuery() is false
ComplianceoptionalThis method must be implemented if supportsInventoryQuery() is true.
MethodgetInventoryQuerySessionForWarehouse
Description

Gets the OsidSession associated with the inventory query service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.InventoryQuerySessionan InventoryQuerySession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT warehouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventoryQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInventoryQuery() and supportsVisibleFederation() are true
MethodgetInventorySearchSession
Description

Gets the OsidSession associated with the inventory search service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.InventorySearchSessiona InventorySearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventorySearch() is false
ComplianceoptionalThis method must be implemented if supportsInventorySearch() is true.
MethodgetInventorySearchSessionForWarehouse
Description

Gets the OsidSession associated with the inventory search service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.InventorySearchSessiona InventorySearchSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventorySearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInventorySearch() and supportsVisibleFederation() are true
MethodgetInventoryAdminSession
Description

Gets the OsidSession associated with the inventory administration service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.InventoryAdminSessiona InventoryAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventoryAdmin() is false
ComplianceoptionalThis method must be implemented if supportsInventoryAdmin() is true.
MethodgetInventoryAdminSessionForWarehouse
Description

Gets the OsidSession associated with the inventory administration service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.InventoryAdminSessiona InventoryAdminSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventoryAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInventoryAdmin() and supportsVisibleFederation() are true
MethodgetInventoryNotificationSession
Description

Gets the OsidSession associated with the inventory notification service.

Parametersosid.inventory.InventoryReceiverinventoryReceiverthe notification callback
osid.proxy.Proxyproxyproxy
Returnosid.inventory.InventoryNotificationSessiona InventoryNotificationSession
ErrorsNULL_ARGUMENT inventoryReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventoryNotification() is false
ComplianceoptionalThis method must be implemented if supportsInventoryNotification() is true.
MethodgetInventoryNotificationSessionForWarehouse
Description

Gets the OsidSession associated with the inventory notification service for the given warehouse.

Parametersosid.inventory.InventoryReceiverinventoryReceiverthe notification callback
osid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.InventoryNotificationSessiona InventoryNotificationSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT inventoryReceiver, warehouseId, or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventoryNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInventoryNotification() and supportsVisibleFederation() are true
MethodgetInventoryWarehouseSession
Description

Gets the OsidSession to lookup inventory/catalog mappings.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.InventoryWarehouseSessiona InventoryCatalogSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventoryCatalog() is false
ComplianceoptionalThis method must be implemented if supportsInventoryCatalog() is true.
MethodgetInventoryWarehouseAssignmentSession
Description

Gets the OsidSession associated with assigning inventories to warehouses.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.InventoryWarehouseAssignmentSessiona InventoryCatalogAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventoryCatalogAssignment() is false
ComplianceoptionalThis method must be implemented if supportsInventoryCatalogAssignment() is true.
MethodgetInventorySmartWarehouseSession
Description

Gets the OsidSession associated with the inventory smart warehouse service.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.InventorySmartWarehouseSessionan InventorySmartWarehouseSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT warehouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventorySmartWarehouse() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsInventorySmartWarehouse() and supportsVisibleFederation() are true
MethodgetWarehouseLookupSession
Description

Gets the OsidSession associated with the warehouse lookup service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.WarehouseLookupSessiona WarehouseLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWarehouseLookup() is false
ComplianceoptionalThis method must be implemented if supportsWarehouseLookup() is true.
MethodgetWarehouseQuerySession
Description

Gets the OsidSession associated with the warehouse query service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.WarehouseQuerySessiona WarehouseQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWarehouseQuery() is false
ComplianceoptionalThis method must be implemented if supportsWarehouseQuery() is true.
MethodgetWarehouseSearchSession
Description

Gets the OsidSession associated with the warehouse search service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.WarehouseSearchSessiona WarehouseSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWarehouseSearch() is false
ComplianceoptionalThis method must be implemented if supportsWarehouseSearch() is true.
MethodgetWarehouseAdminSession
Description

Gets the OsidSession associated with the warehouse administrative service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.WarehouseAdminSessiona WarehouseAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWarehouseAdmin() is false
ComplianceoptionalThis method must be implemented if supportsWarehouseAdmin() is true.
MethodgetWarehouseNotificationSession
Description

Gets the OsidSession associated with the warehouse notification service.

Parametersosid.inventory.WarehouseReceiverwarehouseReceiverthe notification callback
osid.proxy.Proxyproxyproxy
Returnosid.inventory.WarehouseNotificationSessiona WarehouseNotificationSession
ErrorsNULL_ARGUMENT warehouseReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWarehouseNotification() is false
ComplianceoptionalThis method must be implemented if supportsWarehouseNotification() is true.
MethodgetWarehouseHierarchySession
Description

Gets the OsidSession associated with the warehouse hierarchy service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.WarehouseHierarchySessiona WarehouseHierarchySession for warehouses
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWarehouseHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsWarehouseHierarchy() is true.
MethodgetWarehouseHierarchyDesignSession
Description

Gets the OsidSession associated with the warehouse hierarchy design service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.WarehouseHierarchyDesignSessiona HierarchyDesignSession for warehouses
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWarehouseHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsWarehouseHierarchyDesign() is true.
MethodgetInventoryBatchProxyManager
Description

Gets the InventoryBatchProxyManager.

Returnosid.inventory.batch.InventoryBatchProxyManagera InventoryBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventoryBatch() is false
ComplianceoptionalThis method must be implemented if supportsInventoryBatch() is true.
MethodgetInventoryShipmentProxyManager
Description

Gets the InventoryShipmentProxyManager.

Returnosid.inventory.shipment.InventoryShipmentProxyManagera InventoryShipmentProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventoryShipment() is false
ComplianceoptionalThis method must be implemented if supportsInventoryShipment() is true.