org.osid.inventory

Interface InventoryManager

All Superinterfaces:

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

public interface InventoryManager
extends OsidManager, InventoryProfile

The inventory manager provides access to inventory sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• ItemLookupSession: a session to retrieve items
• ItemQuerySession: a session to query items
• ItemSearchSession: a session to search for items
• ItemAdminSession: a session to create and delete items
• ItemNotificationSession: a session to receive notifications pertaining to item changes
• ItemWarehouseSession: a session to look up item to warehouse mappings
• ItemWarehouseAssignmentSession: a session to manage item to warehouse mappings
• ItemSmartWarehouseSession: a session to manage dynamic warehouses of items

• StockLookupSession: a session to retrieve stocks
• StockQuerySession: a session to query stocks
• StockSearchSession: a session to search for stocks
• StockAdminSession: a session to create and delete stocks
• StockNotificationSession: a session to receive notifications pertaining to stock changes
• StockWarehouseSession: a session to look up stock to warehouse mappings
• StockWarehouseSession: a session to look up stock to warehouse mappings
• StockWarehouseAssignmentSession: a session to manage stock to warehouse mappings
• StockSmartWarehouseSession: a session to manage dynamic warehouses of stocks
• StockHierarchySession: a session to traverse a hierarchy of stocks
• StockHierarchyDesignSession: a session to manage a stock hierarchy

• ModelLookupSession: a session to retrieve models
• ModelQuerySession: a session to query models
• ModelSearchSession: a session to search for models
• ModelAdminSession: a session to create and delete models
• ModelNotificationSession: a session to receive notifications pertaining to model changes
• ModelWarehouseSession: a session to look up model to warehouse mappings
• ModelWarehouseSession: a session to look up model to warehouse mappings
• ModelWarehouseAssignmentSession: a session to manage model to warehouse mappings
• ModelSmartWarehouseSession: a session to manage dynamic warehouses of models

• InventoryLookupSession: a session to retrieve inventories
• InventoryLookupSession: a session to query inventories
• InventorySearchSession: a session to search for inventories
• InventoryAdminSession: a session to create and delete inventories
• InventoryNotificationSession: a session to receive notifications pertaining to inventory changes
• InventoryWarehouseSession: a session to look up inventory to warehouse mappings
• InventoryWarehouseAssignmentSession: a session to manage inventory to warehouse mappings
• InventorySmartWarehouseAssignmentSession: a session to manage dynamic warehouses of inventories

• WarehouseLookupSession: a session to retrieve warehouses
• WarehouseQuerySession: a session to query warehouses
• WarehousesearchSession: a session to search for warehouses
• WarehouseAdminSession: a session to create and delete warehouses
• WarehouseNotificationSession: a session to receive notifications pertaining to warehouse changes
• WarehouseHierarchySession: a session to traverse a hierarchy of warehouses
• WarehouseHierarchyDesignSession: a session to manage a warehouse hierarchy

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                       throws OperationFailedException

Gets the OsidSession associated with the item lookup service.

Returns:

an ItemSession

Throws:

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)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

warehouseId - the Id of the warehouse

Returns:

an ItemLookupSession

Throws:

NotFoundException - no Warehouse found by the given Id

NullArgumentException - 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()
                                     throws OperationFailedException

Gets the OsidSession associated with the item query service.

Returns:

an ItemQuerySession

Throws:

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)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

an ItemQuerySession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - 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()
                                       throws OperationFailedException

Gets the OsidSession associated with the item search service.

Returns:

an ItemSearchSession

Throws:

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)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

an ItemSearchSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - 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()
                                     throws OperationFailedException

Gets the OsidSession associated with the item administration service.

Returns:

an ItemAdminSession

Throws:

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)
                                                 throws NotFoundException,
                                                        OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

an ItemAdminSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - 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)
                                                   throws OperationFailedException

Gets the OsidSession associated with the item notification service.

Parameters:

itemReceiver - the notification callback

Returns:

an ItemNotificationSession

Throws:

NullArgumentException - itemReceiver 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)
                                                               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

Returns:

an ItemNotificationSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - itemReceiver or warehouseId 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()
                                             throws OperationFailedException

Gets the OsidSession to lookup item/catalog mappings.

Returns:

an ItemWarehouseSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemWarehouse() is false

Compliance:

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

getItemWarehouseAssignmentSession

ItemWarehouseAssignmentSession getItemWarehouseAssignmentSession()
                                                                 throws OperationFailedException

Gets the OsidSession associated with assigning items to warehouses.

Returns:

an ItemWarehouseAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsItemWarehouseAssignment() is false

Compliance:

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

getItemSmartWarehouseSession

ItemSmartWarehouseSession getItemSmartWarehouseSession(Id warehouseId)
                                                       throws NotFoundException,
                                                              OperationFailedException

Gets the OsidSession associated with the item smart warehouse service.

Parameters:

warehouseId - the Id of the Warehouse

Returns:

an ItemSmartWarehouseSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId 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()
                                         throws OperationFailedException

Gets the OsidSession associated with the stock lookup service.

Returns:

a StockSession

Throws:

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)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

warehouseId - the Id of the warehouse

Returns:

a StockLookupSession

Throws:

NotFoundException - no Warehouse found by the given Id

NullArgumentException - 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()
                                       throws OperationFailedException

Gets the OsidSession associated with the stock query service.

Returns:

a StockQuerySession

Throws:

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)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a StockQuerySession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - 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()
                                         throws OperationFailedException

Gets the OsidSession associated with the stock search service.

Returns:

a StockSearchSession

Throws:

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)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a StockSearchSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - 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()
                                       throws OperationFailedException

Gets the OsidSession associated with the stock administration service.

Returns:

a StockAdminSession

Throws:

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)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a StockAdminSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - 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)
                                                     throws OperationFailedException

Gets the OsidSession associated with the stock notification service.

Parameters:

stockReceiver - the notification callback

Returns:

a StockNotificationSession

Throws:

NullArgumentException - stockReceiver 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)
                                                                 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

Returns:

a StockNotificationSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - stockReceiver or warehouseId 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()
                                               throws OperationFailedException

Gets the OsidSession to lookup stock/catalog mappings.

Returns:

a StockWarehouseSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsStockWarehouse() is false

Compliance:

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

getStockWarehouseAssignmentSession

StockWarehouseAssignmentSession getStockWarehouseAssignmentSession()
                                                                   throws OperationFailedException

Gets the OsidSession associated with assigning stocks to warehouses.

Returns:

a StockWarehouseAssignmentSession

Throws:

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)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the stock smart warehouse service.

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a StockSmartWarehouseSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId 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()
                                               throws OperationFailedException

Gets the stock hierarchy traversal session.

Returns:

a StockHierarchySession

Throws:

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)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the stock hierarchy traversal session for the given warehouse.

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a StockHierarchySession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId 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()
                                                           throws OperationFailedException

Gets the stock hierarchy design session.

Returns:

a StockHierarchyDesignSession

Throws:

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)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the stock hierarchy design session for the given warehouse.

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a StockHierarchyDesignSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId 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()
                                         throws OperationFailedException

Gets the OsidSession associated with the model lookup service.

Returns:

a ModelSession

Throws:

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)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

warehouseId - the Id of the warehouse

Returns:

a ModelLookupSession

Throws:

NotFoundException - no Warehouse found by the given Id

NullArgumentException - 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()
                                       throws OperationFailedException

Gets the OsidSession associated with the model query service.

Returns:

a ModelQuerySession

Throws:

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)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a ModelQuerySession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - 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()
                                         throws OperationFailedException

Gets the OsidSession associated with the model search service.

Returns:

a ModelSearchSession

Throws:

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)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a ModelSearchSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - 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()
                                       throws OperationFailedException

Gets the OsidSession associated with the model administration service.

Returns:

a ModelAdminSession

Throws:

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)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a ModelAdminSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - 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)
                                                     throws OperationFailedException

Gets the OsidSession associated with the model notification service.

Parameters:

modelReceiver - the notification callback

Returns:

a ModelNotificationSession

Throws:

NullArgumentException - modelReceiver 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)
                                                                 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

Returns:

a ModelNotificationSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - modelReceiver or warehouseId 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()
                                               throws OperationFailedException

Gets the OsidSession to lookup model/catalog mappings.

Returns:

a ModelWarehouseSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsModelWarehouse() is false

Compliance:

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

getModelWarehouseAssignmentSession

ModelWarehouseAssignmentSession getModelWarehouseAssignmentSession()
                                                                   throws OperationFailedException

Gets the OsidSession associated with assigning models to warehouses.

Returns:

a ModelWarehouseAssignmentSession

Throws:

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)
                                                         throws NotFoundException,
                                                                OperationFailedException

Gets the OsidSession associated with the model smart warehouse service.

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a ModelSmartWarehouseSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId 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()
                                                 throws OperationFailedException

Gets the OsidSession associated with the inventory lookup service.

Returns:

an InventoryLookupSession

Throws:

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)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

an InventoryLookupSession

Throws:

NotFoundException - no Warehouse found by the given Id

NullArgumentException - 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()
                                               throws OperationFailedException

Gets the OsidSession associated with the inventory query service.

Returns:

an InventoryQuerySession

Throws:

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)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

an InventoryQuerySession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId 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()
                                                 throws OperationFailedException

Gets the OsidSession associated with the inventory search service.

Returns:

an InventorySearchSession

Throws:

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)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

an InventorySearchSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - 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()
                                               throws OperationFailedException

Gets the OsidSession associated with the inventory administration service.

Returns:

an InventoryAdminSession

Throws:

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)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

an InventoryAdminSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - 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)
                                                             throws OperationFailedException

Gets the OsidSession associated with the inventory notification service.

Parameters:

inventoryReceiver - the notification callback

Returns:

an InventoryNotificationSession

Throws:

NullArgumentException - inventoryReceiver 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)
                                                                         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

Returns:

an InventoryNotificationSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - inventoryReceiver or warehouseId 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()
                                                       throws OperationFailedException

Gets the OsidSession to lookup inventory/catalog mappings.

Returns:

an InventoryWarehouseSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryWarehouse() is false

Compliance:

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

getInventoryWarehouseAssignmentSession

InventoryWarehouseAssignmentSession getInventoryWarehouseAssignmentSession()
                                                                           throws OperationFailedException

Gets the OsidSession associated with assigning inventories to warehouses.

Returns:

an InventoryWarehouseAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryWarehouseAssignment() is false

Compliance:

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

getInventorySmartWarehouseSession

InventorySmartWarehouseSession getInventorySmartWarehouseSession(Id warehouseId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the inventory smart warehouse service.

Parameters:

warehouseId - the Id of the Warehouse

Returns:

an InventorySmartWarehouseSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId 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()
                                                 throws OperationFailedException

Gets the OsidSession associated with the warehouse lookup service.

Returns:

a WarehouseLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWarehouseLookup() is false

Compliance:

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

getWarehouseQuerySession

WarehouseQuerySession getWarehouseQuerySession()
                                               throws OperationFailedException

Gets the OsidSession associated with the warehouse query service.

Returns:

a WarehouseQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWarehouseQuery() is false

Compliance:

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

getWarehouseSearchSession

WarehouseSearchSession getWarehouseSearchSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the warehouse search service.

Returns:

a WarehouseSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWarehouseSearch() is false

Compliance:

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

getWarehouseAdminSession

WarehouseAdminSession getWarehouseAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the warehouse administrative service.

Returns:

a WarehouseAdminSession

Throws:

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)
                                                             throws OperationFailedException

Gets the OsidSession associated with the warehouse notification service.

Parameters:

warehouseReceiver - the notification callback

Returns:

a WarehouseNotificationSession

Throws:

NullArgumentException - warehouseReceiver 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()
                                                       throws OperationFailedException

Gets the OsidSession associated with the warehouse hierarchy service.

Returns:

a WarehouseHierarchySession for warehouses

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWarehouseHierarchy() is false

Compliance:

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

getWarehouseHierarchyDesignSession

WarehouseHierarchyDesignSession getWarehouseHierarchyDesignSession()
                                                                   throws OperationFailedException

Gets the OsidSession associated with the warehouse hierarchy design service.

Returns:

a HierarchyDesignSession for warehouses

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWarehouseHierarchyDesign() is false

Compliance:

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

getInventoryBatchManager

InventoryBatchManager getInventoryBatchManager()
                                               throws OperationFailedException

Gets the InventoryBatchManager.

Returns:

a InventoryBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryBatch() is false

Compliance:

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

getInventoryShipmentManager

InventoryShipmentManager getInventoryShipmentManager()
                                                     throws OperationFailedException

Gets the InventoryShipmentManager.

Returns:

a InventoryShipmentManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryShipment() is false

Compliance:

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