org.osid.inventory

Interface InventoryProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, InventoryProfile, OsidProfile, OsidProxyManager, Sourceable

public interface InventoryProxyManager
extends OsidProxyManager, InventoryProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
InventoryAdminSession	getInventoryAdminSession(Proxy proxy) Gets the OsidSession associated with the inventory administration service.
InventoryAdminSession	getInventoryAdminSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the inventory administration service for the given warehouse.
InventoryBatchProxyManager	getInventoryBatchProxyManager() Gets the InventoryBatchProxyManager.
InventoryLookupSession	getInventoryLookupSession(Proxy proxy) Gets the OsidSession associated with the inventory lookup service.
InventoryLookupSession	getInventoryLookupSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the inventory lookup service for the given warehouse.
InventoryNotificationSession	getInventoryNotificationSession(InventoryReceiver inventoryReceiver, Proxy proxy) Gets the OsidSession associated with the inventory notification service.
InventoryNotificationSession	getInventoryNotificationSessionForWarehouse(InventoryReceiver inventoryReceiver, Id warehouseId, Proxy proxy) Gets the OsidSession associated with the inventory notification service for the given warehouse.
InventoryQuerySession	getInventoryQuerySession(Proxy proxy) Gets the OsidSession associated with the inventory query service.
InventoryQuerySession	getInventoryQuerySessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the inventory query service for the given warehouse.
InventorySearchSession	getInventorySearchSession(Proxy proxy) Gets the OsidSession associated with the inventory search service.
InventorySearchSession	getInventorySearchSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the inventory search service for the given warehouse.
InventoryShipmentProxyManager	getInventoryShipmentProxyManager() Gets the InventoryShipmentProxyManager.
InventorySmartWarehouseSession	getInventorySmartWarehouseSession(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the inventory smart warehouse service.
InventoryWarehouseAssignmentSession	getInventoryWarehouseAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning inventories to warehouses.
InventoryWarehouseSession	getInventoryWarehouseSession(Proxy proxy) Gets the OsidSession to lookup inventory/catalog mappings.
ItemAdminSession	getItemAdminSession(Proxy proxy) Gets the OsidSession associated with the item administration service.
ItemAdminSession	getItemAdminSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the item administration service for the given warehouse.
ItemLookupSession	getItemLookupSession(Proxy proxy) Gets the OsidSession associated with the item lookup service.
ItemLookupSession	getItemLookupSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the item lookup service for the given warehouse.
ItemNotificationSession	getItemNotificationSession(ItemReceiver itemReceiver, Proxy proxy) Gets the OsidSession associated with the item notification service.
ItemNotificationSession	getItemNotificationSessionForWarehouse(ItemReceiver itemReceiver, Id warehouseId, Proxy proxy) Gets the OsidSession associated with the item notification service for the given warehouse.
ItemQuerySession	getItemQuerySession(Proxy proxy) Gets the OsidSession associated with the item query service.
ItemQuerySession	getItemQuerySessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the item query service for the given warehouse.
ItemSearchSession	getItemSearchSession(Proxy proxy) Gets the OsidSession associated with the item search service.
ItemSearchSession	getItemSearchSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the item search service for the given warehouse.
ItemSmartWarehouseSession	getItemSmartWarehouseSession(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the item smart warehouse service.
ItemWarehouseAssignmentSession	getItemWarehouseAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning items to warehouses.
ItemWarehouseSession	getItemWarehouseSession(Proxy proxy) Gets the OsidSession to lookup item/catalog mappings.
ModelAdminSession	getModelAdminSession(Proxy proxy) Gets the OsidSession associated with the model administration service.
ModelAdminSession	getModelAdminSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the model administration service for the given warehouse.
ModelLookupSession	getModelLookupSession(Proxy proxy) Gets the OsidSession associated with the model lookup service.
ModelLookupSession	getModelLookupSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the model lookup service for the given warehouse.
ModelNotificationSession	getModelNotificationSession(ModelReceiver modelReceiver, Proxy proxy) Gets the OsidSession associated with the model notification service.
ModelNotificationSession	getModelNotificationSessionForWarehouse(ModelReceiver modelReceiver, Id warehouseId, Proxy proxy) Gets the OsidSession associated with the model notification service for the given warehouse.
ModelQuerySession	getModelQuerySession(Proxy proxy) Gets the OsidSession associated with the model query service.
ModelQuerySession	getModelQuerySessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the model query service for the given warehouse.
ModelSearchSession	getModelSearchSession(Proxy proxy) Gets the OsidSession associated with the model search service.
ModelSearchSession	getModelSearchSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the model search service for the given warehouse.
ModelSmartWarehouseSession	getModelSmartWarehouseSession(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the model smart warehouse service.
ModelWarehouseAssignmentSession	getModelWarehouseAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning models to warehouses.
ModelWarehouseSession	getModelWarehouseSession(Proxy proxy) Gets the OsidSession to lookup model/catalog mappings.
StockAdminSession	getStockAdminSession(Proxy proxy) Gets the OsidSession associated with the stock administration service.
StockAdminSession	getStockAdminSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the stock administration service for the given warehouse.
StockHierarchyDesignSession	getStockHierarchyDesignSession(Proxy proxy) Gets the stock hierarchy design session.
StockHierarchyDesignSession	getStockHierarchyDesignSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the stock hierarchy design session for the given warehouse.
StockHierarchySession	getStockHierarchySession(Proxy proxy) Gets the stock hierarchy traversal session.
StockHierarchySession	getStockHierarchySessionForWarehouse(Id warehouseId, Proxy proxy) Gets the stock hierarchy traversal session for the given warehouse.
StockLookupSession	getStockLookupSession(Proxy proxy) Gets the OsidSession associated with the stock lookup service.
StockLookupSession	getStockLookupSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the stock lookup service for the given warehouse.
StockNotificationSession	getStockNotificationSession(StockReceiver stockReceiver, Proxy proxy) Gets the OsidSession associated with the stock notification service.
StockNotificationSession	getStockNotificationSessionForWarehouse(StockReceiver stockReceiver, Id warehouseId, Proxy proxy) Gets the OsidSession associated with the stock notification service for the given warehouse.
StockQuerySession	getStockQuerySession(Proxy proxy) Gets the OsidSession associated with the stock query service.
StockQuerySession	getStockQuerySessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the stock query service for the given warehouse.
StockSearchSession	getStockSearchSession(Proxy proxy) Gets the OsidSession associated with the stock search service.
StockSearchSession	getStockSearchSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the stock search service for the given warehouse.
StockSmartWarehouseSession	getStockSmartWarehouseSession(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the stock smart warehouse service.
StockWarehouseAssignmentSession	getStockWarehouseAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning stocks to warehouses.
StockWarehouseSession	getStockWarehouseSession(Proxy proxy) Gets the OsidSession to lookup stock/catalog mappings.
WarehouseAdminSession	getWarehouseAdminSession(Proxy proxy) Gets the OsidSession associated with the warehouse administrative service.
WarehouseHierarchyDesignSession	getWarehouseHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the warehouse hierarchy design service.
WarehouseHierarchySession	getWarehouseHierarchySession(Proxy proxy) Gets the OsidSession associated with the warehouse hierarchy service.
WarehouseLookupSession	getWarehouseLookupSession(Proxy proxy) Gets the OsidSession associated with the warehouse lookup service.
WarehouseNotificationSession	getWarehouseNotificationSession(WarehouseReceiver warehouseReceiver, Proxy proxy) Gets the OsidSession associated with the warehouse notification service.
WarehouseQuerySession	getWarehouseQuerySession(Proxy proxy) Gets the OsidSession associated with the warehouse query service.
WarehouseSearchSession	getWarehouseSearchSession(Proxy proxy) Gets the OsidSession associated with the warehouse search service.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.inventory.InventoryProfile

getInventoryRecordTypes, getInventorySearchRecordTypes, getItemRecordTypes, getItemSearchRecordTypes, getModelRecordTypes, getModelSearchRecordTypes, getStockRecordTypes, getStockSearchRecordTypes, getWarehouseRecordTypes, getWarehouseSearchRecordTypes, supportsInventoryAdmin, supportsInventoryBatch, supportsInventoryLookup, supportsInventoryNotification, supportsInventoryQuery, supportsInventoryRecordType, supportsInventorySearch, supportsInventorySearchRecordType, supportsInventoryShipment, supportsInventorySmartWarehouse, supportsInventoryWarehouse, supportsInventoryWarehouseAssignment, supportsItemAdmin, supportsItemLookup, supportsItemNotification, supportsItemQuery, supportsItemRecordType, supportsItemSearch, supportsItemSearchRecordType, supportsItemSmartWarehouse, supportsItemWarehouse, supportsItemWarehouseAssignment, supportsModelAdmin, supportsModelLookup, supportsModelNotification, supportsModelQuery, supportsModelRecordType, supportsModelSearch, supportsModelSearchRecordType, supportsModelSmartWarehouse, supportsModelWarehouse, supportsModelWarehouseAssignment, supportsStockAdmin, supportsStockHierarchy, supportsStockHierarchyDesign, supportsStockLookup, supportsStockNotification, supportsStockQuery, supportsStockRecordType, supportsStockSearch, supportsStockSearchRecordType, supportsStockSmartWarehouse, supportsStockWarehouse, supportsStockWarehouseAssignment, supportsVisibleFederation, supportsWarehouseAdmin, supportsWarehouseHierarchy, supportsWarehouseHierarchyDesign, supportsWarehouseLookup, supportsWarehouseNotification, supportsWarehouseQuery, supportsWarehouseRecordType, supportsWarehouseSearch, supportsWarehouseSearchRecordType

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getItemLookupSession

ItemLookupSession getItemLookupSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the item lookup service.

Parameters:

proxy - proxy

Returns:

an ItemLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemLookup() is false

Compliance:

optional - This method must be implemented if supportsItemLookup() is true.

getItemLookupSessionForWarehouse

ItemLookupSession getItemLookupSessionForWarehouse(Id warehouseId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

an ItemLookupSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsItemLookup() and supportsVisibleFederation() are true

getItemQuerySession

ItemQuerySession getItemQuerySession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the item query service.

Parameters:

proxy - proxy

Returns:

an ItemQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemQuery() is false

Compliance:

optional - This method must be implemented if supportsItemQuery() is true.

getItemQuerySessionForWarehouse

ItemQuerySession getItemQuerySessionForWarehouse(Id warehouseId,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

an ItemQuerySession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsItemQuery() and supportsVisibleFederation() are true

getItemSearchSession

ItemSearchSession getItemSearchSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the item search service.

Parameters:

proxy - proxy

Returns:

an ItemSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemSearch() is false

Compliance:

optional - This method must be implemented if supportsItemSearch() is true.

getItemSearchSessionForWarehouse

ItemSearchSession getItemSearchSessionForWarehouse(Id warehouseId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

an ItemSearchSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsItemSearch() and supportsVisibleFederation() are true

getItemAdminSession

ItemAdminSession getItemAdminSession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the item administration service.

Parameters:

proxy - proxy

Returns:

an ItemAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemAdmin() is false

Compliance:

optional - This method must be implemented if supportsItemAdmin() is true.

getItemAdminSessionForWarehouse

ItemAdminSession getItemAdminSessionForWarehouse(Id warehouseId,
                                               Proxy proxy)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

an ItemAdminSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsItemAdmin() and supportsVisibleFederation() are true

getItemNotificationSession

ItemNotificationSession getItemNotificationSession(ItemReceiver itemReceiver,
                                                 Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the item notification service.

Parameters:

itemReceiver - the notification callback

proxy - proxy

Returns:

an ItemNotificationSession

Throws:

NullArgumentException - itemReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemNotification() is false

Compliance:

optional - This method must be implemented if supportsItemNotification() is true.

getItemNotificationSessionForWarehouse

ItemNotificationSession getItemNotificationSessionForWarehouse(ItemReceiver itemReceiver,
                                                             Id warehouseId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

itemReceiver - the notification callback

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

an ItemNotificationSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - itemReceiver, warehouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsItemNotification() and supportsVisibleFederation() are true

getItemWarehouseSession

ItemWarehouseSession getItemWarehouseSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession to lookup item/catalog mappings.

Parameters:

proxy - proxy

Returns:

an ItemCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemCatalog() is false

Compliance:

optional - This method must be implemented if supportsItemCatalog() is true.

getItemWarehouseAssignmentSession

ItemWarehouseAssignmentSession getItemWarehouseAssignmentSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with assigning items to warehouses.

Parameters:

proxy - proxy

Returns:

an ItemCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemCatalogAssignment() is false

Compliance:

optional - This method must be implemented if supportsItemCatalogAssignment() is true.

getItemSmartWarehouseSession

ItemSmartWarehouseSession getItemSmartWarehouseSession(Id warehouseId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the item smart warehouse service.

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

an ItemSmartWarehouseSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsItemSmartWarehouse() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsItemSmartWarehouse() and supportsVisibleFederation() are true

getStockLookupSession

StockLookupSession getStockLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the stock lookup service.

Parameters:

proxy - proxy

Returns:

a StockSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockLookup() is false

Compliance:

optional - This method must be implemented if supportsStockLookup() is true.

getStockLookupSessionForWarehouse

StockLookupSession getStockLookupSessionForWarehouse(Id warehouseId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

warehouseId - the Id of the warehouse

proxy - proxy

Returns:

a StockLookupSession

Throws:

NotFoundException - no Warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStockLookup() and supportsVisibleFederation() are true

getStockQuerySession

StockQuerySession getStockQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the stock query service.

Parameters:

proxy - proxy

Returns:

a StockQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockQuery() is false

Compliance:

optional - This method must be implemented if supportsStockQuery() is true.

getStockQuerySessionForWarehouse

StockQuerySession getStockQuerySessionForWarehouse(Id warehouseId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a StockQuerySession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStockQuery() and supportsVisibleFederation() are true

getStockSearchSession

StockSearchSession getStockSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the stock search service.

Parameters:

proxy - proxy

Returns:

a StockSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockSearch() is false

Compliance:

optional - This method must be implemented if supportsStockSearch() is true.

getStockSearchSessionForWarehouse

StockSearchSession getStockSearchSessionForWarehouse(Id warehouseId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a StockSearchSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStockSearch() and supportsVisibleFederation() are true

getStockAdminSession

StockAdminSession getStockAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the stock administration service.

Parameters:

proxy - proxy

Returns:

a StockAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockAdmin() is false

Compliance:

optional - This method must be implemented if supportsStockAdmin() is true.

getStockAdminSessionForWarehouse

StockAdminSession getStockAdminSessionForWarehouse(Id warehouseId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a StockAdminSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStockAdmin() and supportsVisibleFederation() are true

getStockNotificationSession

StockNotificationSession getStockNotificationSession(StockReceiver stockReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the stock notification service.

Parameters:

stockReceiver - the notification callback

proxy - proxy

Returns:

a StockNotificationSession

Throws:

NullArgumentException - stockReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockNotification() is false

Compliance:

optional - This method must be implemented if supportsStockNotification() is true.

getStockNotificationSessionForWarehouse

StockNotificationSession getStockNotificationSessionForWarehouse(StockReceiver stockReceiver,
                                                               Id warehouseId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

stockReceiver - the notification callback

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a StockNotificationSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - stockReceiver, warehouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStockNotification() and supportsVisibleFederation() are true

getStockWarehouseSession

StockWarehouseSession getStockWarehouseSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession to lookup stock/catalog mappings.

Parameters:

proxy - proxy

Returns:

a StockWarehouseSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockWarehouse() is false

Compliance:

optional - This method must be implemented if supportsStockWarehouse() is true.

getStockWarehouseAssignmentSession

StockWarehouseAssignmentSession getStockWarehouseAssignmentSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with assigning stocks to warehouses.

Parameters:

proxy - proxy

Returns:

a StockWarehouseAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockWarehouseAssignment() is false

Compliance:

optional - This method must be implemented if supportsStockWarehouseAssignment() is true.

getStockSmartWarehouseSession

StockSmartWarehouseSession getStockSmartWarehouseSession(Id warehouseId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the stock smart warehouse service.

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a StockSmartWarehouseSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockSmartWarehouse() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStockSmartWarehouse() and supportsVisibleFederation() are true

getStockHierarchySession

StockHierarchySession getStockHierarchySession(Proxy proxy)
                                               throws OperationFailedException

Gets the stock hierarchy traversal session.

Parameters:

proxy - proxy

Returns:

a StockHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockHierarchy() is false

Compliance:

optional - This method must be implemented if supportsStockHierarchy() is true.

getStockHierarchySessionForWarehouse

StockHierarchySession getStockHierarchySessionForWarehouse(Id warehouseId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the stock hierarchy traversal session for the given warehouse.

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a StockHierarchySession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockHierarchy() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStockHierarchy() and supportsVisibleFederation() are true

getStockHierarchyDesignSession

StockHierarchyDesignSession getStockHierarchyDesignSession(Proxy proxy)
                                                           throws OperationFailedException

Gets the stock hierarchy design session.

Parameters:

proxy - proxy

Returns:

a StockHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsStockHierarchyDesign() is true.

getStockHierarchyDesignSessionForWarehouse

StockHierarchyDesignSession getStockHierarchyDesignSessionForWarehouse(Id warehouseId,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the stock hierarchy design session for the given warehouse.

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a StockHierarchyDesignSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsStockHierarchyDesign() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsStockHierarchyDesign() and supportsVisibleFederation() are true

getModelLookupSession

ModelLookupSession getModelLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the model lookup service.

Parameters:

proxy - proxy

Returns:

a ModelSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelLookup() is false

Compliance:

optional - This method must be implemented if supportsModelLookup() is true.

getModelLookupSessionForWarehouse

ModelLookupSession getModelLookupSessionForWarehouse(Id warehouseId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

warehouseId - the Id of the warehouse

proxy - proxy

Returns:

a ModelLookupSession

Throws:

NotFoundException - no Warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsModelLookup() and supportsVisibleFederation() are true

getModelQuerySession

ModelQuerySession getModelQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the model query service.

Parameters:

proxy - proxy

Returns:

a ModelQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelQuery() is false

Compliance:

optional - This method must be implemented if supportsModelQuery() is true.

getModelQuerySessionForWarehouse

ModelQuerySession getModelQuerySessionForWarehouse(Id warehouseId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a ModelQuerySession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsModelQuery() and supportsVisibleFederation() are true

getModelSearchSession

ModelSearchSession getModelSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the model search service.

Parameters:

proxy - proxy

Returns:

a ModelSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelSearch() is false

Compliance:

optional - This method must be implemented if supportsModelSearch() is true.

getModelSearchSessionForWarehouse

ModelSearchSession getModelSearchSessionForWarehouse(Id warehouseId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a ModelSearchSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsModelSearch() and supportsVisibleFederation() are true

getModelAdminSession

ModelAdminSession getModelAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the model administration service.

Parameters:

proxy - proxy

Returns:

a ModelAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelAdmin() is false

Compliance:

optional - This method must be implemented if supportsModelAdmin() is true.

getModelAdminSessionForWarehouse

ModelAdminSession getModelAdminSessionForWarehouse(Id warehouseId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a ModelAdminSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsModelAdmin() and supportsVisibleFederation() are true

getModelNotificationSession

ModelNotificationSession getModelNotificationSession(ModelReceiver modelReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the model notification service.

Parameters:

modelReceiver - the notification callback

proxy - proxy

Returns:

a ModelNotificationSession

Throws:

NullArgumentException - modelReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelNotification() is false

Compliance:

optional - This method must be implemented if supportsModelNotification() is true.

getModelNotificationSessionForWarehouse

ModelNotificationSession getModelNotificationSessionForWarehouse(ModelReceiver modelReceiver,
                                                               Id warehouseId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

modelReceiver - the notification callback

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a ModelNotificationSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - modelReceiver, warehouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsModelNotification() and supportsVisibleFederation() are true

getModelWarehouseSession

ModelWarehouseSession getModelWarehouseSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession to lookup model/catalog mappings.

Parameters:

proxy - proxy

Returns:

a ModelWarehouseSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelWarehouse() is false

Compliance:

optional - This method must be implemented if supportsModelWarehouse() is true.

getModelWarehouseAssignmentSession

ModelWarehouseAssignmentSession getModelWarehouseAssignmentSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with assigning models to warehouses.

Parameters:

proxy - proxy

Returns:

a ModelWarehouseAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelWarehouseAssignment() is false

Compliance:

optional - This method must be implemented if supportsModelWarehouseAssignment() is true.

getModelSmartWarehouseSession

ModelSmartWarehouseSession getModelSmartWarehouseSession(Id warehouseId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the model smart warehouse service.

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a ModelSmartWarehouseSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsModelSmartWarehouse() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsModelSmartWarehouse() and supportsVisibleFederation() are true

getInventoryLookupSession

InventoryLookupSession getInventoryLookupSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the inventory lookup service.

Parameters:

proxy - proxy

Returns:

a InventoryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryLookup() is false

Compliance:

optional - This method must be implemented if supportsInventoryLookup() is true.

getInventoryLookupSessionForWarehouse

InventoryLookupSession getInventoryLookupSessionForWarehouse(Id warehouseId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a InventoryLookupSession

Throws:

NotFoundException - no Warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInventoryLookup() and supportsVisibleFederation() are true

getInventoryQuerySession

InventoryQuerySession getInventoryQuerySession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the inventory query service.

Parameters:

proxy - proxy

Returns:

an InventoryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryQuery() is false

Compliance:

optional - This method must be implemented if supportsInventoryQuery() is true.

getInventoryQuerySessionForWarehouse

InventoryQuerySession getInventoryQuerySessionForWarehouse(Id warehouseId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

an InventoryQuerySession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInventoryQuery() and supportsVisibleFederation() are true

getInventorySearchSession

InventorySearchSession getInventorySearchSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the inventory search service.

Parameters:

proxy - proxy

Returns:

a InventorySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventorySearch() is false

Compliance:

optional - This method must be implemented if supportsInventorySearch() is true.

getInventorySearchSessionForWarehouse

InventorySearchSession getInventorySearchSessionForWarehouse(Id warehouseId,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a InventorySearchSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventorySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInventorySearch() and supportsVisibleFederation() are true

getInventoryAdminSession

InventoryAdminSession getInventoryAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the inventory administration service.

Parameters:

proxy - proxy

Returns:

a InventoryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryAdmin() is false

Compliance:

optional - This method must be implemented if supportsInventoryAdmin() is true.

getInventoryAdminSessionForWarehouse

InventoryAdminSession getInventoryAdminSessionForWarehouse(Id warehouseId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a InventoryAdminSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInventoryAdmin() and supportsVisibleFederation() are true

getInventoryNotificationSession

InventoryNotificationSession getInventoryNotificationSession(InventoryReceiver inventoryReceiver,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the inventory notification service.

Parameters:

inventoryReceiver - the notification callback

proxy - proxy

Returns:

a InventoryNotificationSession

Throws:

NullArgumentException - inventoryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryNotification() is false

Compliance:

optional - This method must be implemented if supportsInventoryNotification() is true.

getInventoryNotificationSessionForWarehouse

InventoryNotificationSession getInventoryNotificationSessionForWarehouse(InventoryReceiver inventoryReceiver,
                                                                       Id warehouseId,
                                                                       Proxy proxy)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

inventoryReceiver - the notification callback

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a InventoryNotificationSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - inventoryReceiver, warehouseId, or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInventoryNotification() and supportsVisibleFederation() are true

getInventoryWarehouseSession

InventoryWarehouseSession getInventoryWarehouseSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession to lookup inventory/catalog mappings.

Parameters:

proxy - proxy

Returns:

a InventoryCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryCatalog() is false

Compliance:

optional - This method must be implemented if supportsInventoryCatalog() is true.

getInventoryWarehouseAssignmentSession

InventoryWarehouseAssignmentSession getInventoryWarehouseAssignmentSession(Proxy proxy)
                                                                           throws OperationFailedException

Gets the OsidSession associated with assigning inventories to warehouses.

Parameters:

proxy - proxy

Returns:

a InventoryCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryCatalogAssignment() is false

Compliance:

optional - This method must be implemented if supportsInventoryCatalogAssignment() is true.

getInventorySmartWarehouseSession

InventorySmartWarehouseSession getInventorySmartWarehouseSession(Id warehouseId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the inventory smart warehouse service.

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

an InventorySmartWarehouseSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventorySmartWarehouse() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsInventorySmartWarehouse() and supportsVisibleFederation() are true

getWarehouseLookupSession

WarehouseLookupSession getWarehouseLookupSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the warehouse lookup service.

Parameters:

proxy - proxy

Returns:

a WarehouseLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWarehouseLookup() is false

Compliance:

optional - This method must be implemented if supportsWarehouseLookup() is true.

getWarehouseQuerySession

WarehouseQuerySession getWarehouseQuerySession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the warehouse query service.

Parameters:

proxy - proxy

Returns:

a WarehouseQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWarehouseQuery() is false

Compliance:

optional - This method must be implemented if supportsWarehouseQuery() is true.

getWarehouseSearchSession

WarehouseSearchSession getWarehouseSearchSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the warehouse search service.

Parameters:

proxy - proxy

Returns:

a WarehouseSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWarehouseSearch() is false

Compliance:

optional - This method must be implemented if supportsWarehouseSearch() is true.

getWarehouseAdminSession

WarehouseAdminSession getWarehouseAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the warehouse administrative service.

Parameters:

proxy - proxy

Returns:

a WarehouseAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWarehouseAdmin() is false

Compliance:

optional - This method must be implemented if supportsWarehouseAdmin() is true.

getWarehouseNotificationSession

WarehouseNotificationSession getWarehouseNotificationSession(WarehouseReceiver warehouseReceiver,
                                                           Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with the warehouse notification service.

Parameters:

warehouseReceiver - the notification callback

proxy - proxy

Returns:

a WarehouseNotificationSession

Throws:

NullArgumentException - warehouseReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWarehouseNotification() is false

Compliance:

optional - This method must be implemented if supportsWarehouseNotification() is true.

getWarehouseHierarchySession

WarehouseHierarchySession getWarehouseHierarchySession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the warehouse hierarchy service.

Parameters:

proxy - proxy

Returns:

a WarehouseHierarchySession for warehouses

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWarehouseHierarchy() is false

Compliance:

optional - This method must be implemented if supportsWarehouseHierarchy() is true.

getWarehouseHierarchyDesignSession

WarehouseHierarchyDesignSession getWarehouseHierarchyDesignSession(Proxy proxy)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the warehouse hierarchy design service.

Parameters:

proxy - proxy

Returns:

a HierarchyDesignSession for warehouses

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWarehouseHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsWarehouseHierarchyDesign() is true.

getInventoryBatchProxyManager

InventoryBatchProxyManager getInventoryBatchProxyManager()
                                                         throws OperationFailedException

Gets the InventoryBatchProxyManager.

Returns:

a InventoryBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryBatch() is false

Compliance:

optional - This method must be implemented if supportsInventoryBatch() is true.

getInventoryShipmentProxyManager

InventoryShipmentProxyManager getInventoryShipmentProxyManager()
                                                               throws OperationFailedException

Gets the InventoryShipmentProxyManager.

Returns:

a InventoryShipmentProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryShipment() is false

Compliance:

optional - This method must be implemented if supportsInventoryShipment() is true.