Interface | osid.inventory.InventoryProxyManager | ||
---|---|---|---|
Implements | osid.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
| ||
Method | getItemLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.ItemLookupSession | an ItemLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsItemLookup() is false | ||
Compliance | optional | This method must be implemented if supportsItemLookup() is
true. | |
Method | getItemLookupSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.ItemLookupSession | an ItemLookupSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.ItemQuerySession | an ItemQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsItemQuery() is false | ||
Compliance | optional | This method must be implemented if supportsItemQuery() is
true. | |
Method | getItemQuerySessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.ItemQuerySession | an ItemQuerySession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.ItemSearchSession | an ItemSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsItemSearch() is false | ||
Compliance | optional | This method must be implemented if supportsItemSearch() is
true. | |
Method | getItemSearchSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.ItemSearchSession | an ItemSearchSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.ItemAdminSession | an ItemAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsItemAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsItemAdmin() is
true. | |
Method | getItemAdminSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.ItemAdminSession | an ItemAdminSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.inventory.ItemReceiver | itemReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.ItemNotificationSession | an ItemNotificationSession | |
Errors | NULL_ARGUMENT | itemReceiver or proxy 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 | ||
Parameters | osid.inventory.ItemReceiver | itemReceiver | the notification callback |
osid.id.Id | warehouseId | the Id of the Warehouse | |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.ItemNotificationSession | an ItemNotificationSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | itemReceiver, warehouseId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.ItemWarehouseSession | an ItemCatalogSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsItemCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsItemCatalog() is
true. | |
Method | getItemWarehouseAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.ItemWarehouseAssignmentSession | an ItemCatalogAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsItemCatalogAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsItemCatalogAssignment()
is true. | |
Method | getItemSmartWarehouseSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.ItemSmartWarehouseSession | an ItemSmartWarehouseSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | warehouseId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.StockLookupSession | a StockSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStockLookup() is false | ||
Compliance | optional | This method must be implemented if supportsStockLookup() is
true. | |
Method | getStockLookupSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.StockLookupSession | a StockLookupSession | |
Errors | NOT_FOUND | no Warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.StockQuerySession | a StockQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStockQuery() is false | ||
Compliance | optional | This method must be implemented if supportsStockQuery() is
true. | |
Method | getStockQuerySessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.StockQuerySession | a StockQuerySession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.StockSearchSession | a StockSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStockSearch() is false | ||
Compliance | optional | This method must be implemented if supportsStockSearch() is
true. | |
Method | getStockSearchSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.StockSearchSession | a StockSearchSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.StockAdminSession | a StockAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStockAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsStockAdmin() is
true. | |
Method | getStockAdminSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.StockAdminSession | a StockAdminSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.inventory.StockReceiver | stockReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.StockNotificationSession | a StockNotificationSession | |
Errors | NULL_ARGUMENT | stockReceiver or proxy 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 | ||
Parameters | osid.inventory.StockReceiver | stockReceiver | the notification callback |
osid.id.Id | warehouseId | the Id of the Warehouse | |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.StockNotificationSession | a StockNotificationSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | stockReceiver, warehouseId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.StockWarehouseSession | a StockWarehouseSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStockWarehouse() is false | ||
Compliance | optional | This method must be implemented if supportsStockWarehouse()
is true. | |
Method | getStockWarehouseAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.StockWarehouseAssignmentSession | a StockWarehouseAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsStockWarehouseAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsStockWarehouseAssignment() is true. | |
Method | getStockSmartWarehouseSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.StockSmartWarehouseSession | a StockSmartWarehouseSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | warehouseId or proxy 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. | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.StockHierarchySession | a StockHierarchySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
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 |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.StockHierarchySession | a StockHierarchySession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | warehouseId or proxy 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. | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.StockHierarchyDesignSession | a StockHierarchyDesignSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
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 |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.StockHierarchyDesignSession | a StockHierarchyDesignSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | warehouseId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.ModelLookupSession | a ModelSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsModelLookup() is false | ||
Compliance | optional | This method must be implemented if supportsModelLookup() is
true. | |
Method | getModelLookupSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.ModelLookupSession | a ModelLookupSession | |
Errors | NOT_FOUND | no Warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.ModelQuerySession | a ModelQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsModelQuery() is false | ||
Compliance | optional | This method must be implemented if supportsModelQuery() is
true. | |
Method | getModelQuerySessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.ModelQuerySession | a ModelQuerySession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.ModelSearchSession | a ModelSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsModelSearch() is false | ||
Compliance | optional | This method must be implemented if supportsModelSearch() is
true. | |
Method | getModelSearchSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.ModelSearchSession | a ModelSearchSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.ModelAdminSession | a ModelAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsModelAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsModelAdmin() is
true. | |
Method | getModelAdminSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.ModelAdminSession | a ModelAdminSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.inventory.ModelReceiver | modelReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.ModelNotificationSession | a ModelNotificationSession | |
Errors | NULL_ARGUMENT | modelReceiver or proxy 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 | ||
Parameters | osid.inventory.ModelReceiver | modelReceiver | the notification callback |
osid.id.Id | warehouseId | the Id of the Warehouse | |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.ModelNotificationSession | a ModelNotificationSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | modelReceiver, warehouseId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.ModelWarehouseSession | a ModelWarehouseSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsModelWarehouse() is false | ||
Compliance | optional | This method must be implemented if supportsModelWarehouse()
is true. | |
Method | getModelWarehouseAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.ModelWarehouseAssignmentSession | a ModelWarehouseAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsModelWarehouseAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsModelWarehouseAssignment() is true. | |
Method | getModelSmartWarehouseSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.ModelSmartWarehouseSession | a ModelSmartWarehouseSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | warehouseId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.InventoryLookupSession | a InventoryLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInventoryLookup() is false | ||
Compliance | optional | This method must be implemented if supportsInventoryLookup()
is true. | |
Method | getInventoryLookupSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.InventoryLookupSession | a InventoryLookupSession | |
Errors | NOT_FOUND | no Warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.InventoryQuerySession | an InventoryQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInventoryQuery() is false | ||
Compliance | optional | This method must be implemented if supportsInventoryQuery()
is true. | |
Method | getInventoryQuerySessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.InventoryQuerySession | an InventoryQuerySession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | warehouseId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.InventorySearchSession | a InventorySearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInventorySearch() is false | ||
Compliance | optional | This method must be implemented if supportsInventorySearch()
is true. | |
Method | getInventorySearchSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.InventorySearchSession | a InventorySearchSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.InventoryAdminSession | a InventoryAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInventoryAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsInventoryAdmin()
is true. | |
Method | getInventoryAdminSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.InventoryAdminSession | a InventoryAdminSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.inventory.InventoryReceiver | inventoryReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.InventoryNotificationSession | a InventoryNotificationSession | |
Errors | NULL_ARGUMENT | inventoryReceiver or proxy 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 | ||
Parameters | osid.inventory.InventoryReceiver | inventoryReceiver | the notification callback |
osid.id.Id | warehouseId | the Id of the Warehouse | |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.InventoryNotificationSession | a InventoryNotificationSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | inventoryReceiver, warehouseId, or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.InventoryWarehouseSession | a InventoryCatalogSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInventoryCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsInventoryCatalog()
is true. | |
Method | getInventoryWarehouseAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.InventoryWarehouseAssignmentSession | a InventoryCatalogAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsInventoryCatalogAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsInventoryCatalogAssignment() is true. | |
Method | getInventorySmartWarehouseSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.InventorySmartWarehouseSession | an InventorySmartWarehouseSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | warehouseId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.WarehouseLookupSession | a WarehouseLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWarehouseLookup() is false | ||
Compliance | optional | This method must be implemented if supportsWarehouseLookup()
is true. | |
Method | getWarehouseQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.WarehouseQuerySession | a WarehouseQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWarehouseQuery() is false | ||
Compliance | optional | This method must be implemented if supportsWarehouseQuery()
is true. | |
Method | getWarehouseSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.WarehouseSearchSession | a WarehouseSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWarehouseSearch() is false | ||
Compliance | optional | This method must be implemented if supportsWarehouseSearch()
is true. | |
Method | getWarehouseAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.WarehouseAdminSession | a WarehouseAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWarehouseAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsWarehouseAdmin()
is true. | |
Method | getWarehouseNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.inventory.WarehouseReceiver | warehouseReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.WarehouseNotificationSession | a WarehouseNotificationSession | |
Errors | NULL_ARGUMENT | warehouseReceiver or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.WarehouseHierarchySession | a WarehouseHierarchySession for warehouses | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWarehouseHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsWarehouseHierarchy()
is true. | |
Method | getWarehouseHierarchyDesignSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.WarehouseHierarchyDesignSession | a HierarchyDesignSession for warehouses | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsWarehouseHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if
supportsWarehouseHierarchyDesign() is true. | |
Method | getInventoryBatchProxyManager | ||
Description |
Gets the | ||
Return | osid.inventory.batch.InventoryBatchProxyManager | a InventoryBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInventoryBatch() is false | ||
Compliance | optional | This method must be implemented if supportsInventoryBatch()
is true. | |
Method | getInventoryShipmentProxyManager | ||
Description |
Gets the | ||
Return | osid.inventory.shipment.InventoryShipmentProxyManager | a InventoryShipmentProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInventoryShipment() is false | ||
Compliance | optional | This method must be implemented if supportsInventoryShipment()
is true. |