Interface InventoryProxyManager

All Superinterfaces:

AutoCloseable, Closeable, InventoryProfile, OsidProfile, OsidProxyManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getInventoryRecordTypes()	Gets the supported Inventory record types.
TypeList	getInventorySearchRecordTypes()	Gets the supported Inventory search record types.
TypeList	getItemRecordTypes()	Gets the supported Item record types.
TypeList	getItemSearchRecordTypes()	Gets the supported Item search record types.
TypeList	getModelRecordTypes()	Gets the supported Model record types.
TypeList	getModelSearchRecordTypes()	Gets the supported Model search record types.
TypeList	getStockRecordTypes()	Gets the supported Stock record types.
TypeList	getStockSearchRecordTypes()	Gets the supported Stock search record types.
TypeList	getWarehouseRecordTypes()	Gets the supported Warehouse record types.
TypeList	getWarehouseSearchRecordTypes()	Gets the supported Warehouse search record types.
boolean	supportsInventoryAdmin()	Tests if inventory administrative service is supported.
boolean	supportsInventoryBatch()	Tests for the availability of an inventory batch service.
boolean	supportsInventoryLookup()	Tests if looking up inventories is supported.
boolean	supportsInventoryNotification()	Tests if an inventory notification service is supported.
boolean	supportsInventoryQuery()	Tests if querying inventories is supported.
boolean	supportsInventoryRecordType(Type inventoryRecordType)	Tests if the given Inventory record type is supported.
boolean	supportsInventorySearch()	Tests if searching inventories is supported.
boolean	supportsInventorySearchRecordType(Type inventorySearchRecordType)	Tests if the given Inventory search record type is supported.
boolean	supportsInventoryShipment()	Tests for the availability of an inventory shipment service.
boolean	supportsInventorySmartWarehouse()	Tests if an inventory smart warehouse session is available.
boolean	supportsInventoryWarehouse()	Tests if an inventory cataloging service is supported.
boolean	supportsInventoryWarehouseAssignment()	Tests if an inventory cataloging service is supported.
boolean	supportsItemAdmin()	Tests if an item administrative service is supported.
boolean	supportsItemLookup()	Tests if looking up items is supported.
boolean	supportsItemNotification()	Tests if an item notification service is supported.
boolean	supportsItemQuery()	Tests if querying items is supported.
boolean	supportsItemRecordType(Type itemRecordType)	Tests if the given Item record type is supported.
boolean	supportsItemSearch()	Tests if searching items is supported.
boolean	supportsItemSearchRecordType(Type itemSearchRecordType)	Tests if the given Item search record type is supported.
boolean	supportsItemSmartWarehouse()	Tests if an item smart warehouse session is available.
boolean	supportsItemWarehouse()	Tests if an item cataloging service is supported.
boolean	supportsItemWarehouseAssignment()	Tests if an item cataloging service is supported.
boolean	supportsModelAdmin()	Tests if a stock administrative service is supported.
boolean	supportsModelLookup()	Tests if looking up models is supported.
boolean	supportsModelNotification()	Tests if a model notification service is supported.
boolean	supportsModelQuery()	Tests if querying models is supported.
boolean	supportsModelRecordType(Type modelRecordType)	Tests if the given Model record type is supported.
boolean	supportsModelSearch()	Tests if searching models is supported.
boolean	supportsModelSearchRecordType(Type modelSearchRecordType)	Tests if the given Model search record type is supported.
boolean	supportsModelSmartWarehouse()	Tests if a model smart warehouse session is available.
boolean	supportsModelWarehouse()	Tests if a model cataloging service is supported.
boolean	supportsModelWarehouseAssignment()	Tests if a model cataloging service is supported.
boolean	supportsStockAdmin()	Tests if stock administrative service is supported.
boolean	supportsStockHierarchy()	Tests for the availability of a stock hierarchy traversal service.
boolean	supportsStockHierarchyDesign()	Tests for the availability of a stock hierarchy design service.
boolean	supportsStockLookup()	Tests if looking up stocks is supported.
boolean	supportsStockNotification()	Tests if a stock notification service is supported.
boolean	supportsStockQuery()	Tests if querying stocks is supported.
boolean	supportsStockRecordType(Type stockRecordType)	Tests if the given Stock record type is supported.
boolean	supportsStockSearch()	Tests if searching stocks is supported.
boolean	supportsStockSearchRecordType(Type stockSearchRecordType)	Tests if the given Stock search record type is supported.
boolean	supportsStockSmartWarehouse()	Tests if a stock smart warehouse session is available.
boolean	supportsStockWarehouse()	Tests if a stock cataloging service is supported.
boolean	supportsStockWarehouseAssignment()	Tests if a stock cataloging service is supported.
boolean	supportsVisibleFederation()	Tests if visible federation is supported.
boolean	supportsWarehouseAdmin()	Tests if warehouse administrative service is supported.
boolean	supportsWarehouseHierarchy()	Tests for the availability of a warehouse hierarchy traversal service.
boolean	supportsWarehouseHierarchyDesign()	Tests for the availability of a warehouse hierarchy design service.
boolean	supportsWarehouseLookup()	Tests if looking up warehouses is supported.
boolean	supportsWarehouseNotification()	Tests if a warehouse notification service is supported.
boolean	supportsWarehouseQuery()	Tests if querying warehouses is supported.
boolean	supportsWarehouseRecordType(Type warehouseRecordType)	Tests if the given Warehouse record type is supported.
boolean	supportsWarehouseSearch()	Tests if searching warehouses is supported.
boolean	supportsWarehouseSearchRecordType(Type warehouseSearchRecordType)	Tests if the given Warehouse search record type is supported.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsItemLookup()} is {@code 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 {@code supportsItemLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsItemQuery()} is {@code 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 {@code supportsItemQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsItemSearch()} is {@code 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 {@code supportsItemSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsItemAdmin()} is {@code 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 {@code supportsItemAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsItemNotification()} is {@code 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 {@code supportsItemNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsItemCatalog()} is {@code 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 {@code supportsItemCatalogAssignment()} is {@code 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 {@code supportsItemSmartWarehouse()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsStockLookup()} is {@code 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 {@code supportsStockLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsStockQuery()} is {@code 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 {@code supportsStockQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsStockSearch()} is {@code 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 {@code supportsStockSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsStockAdmin()} is {@code 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 {@code supportsStockAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsStockNotification()} is {@code 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 {@code supportsStockNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsStockWarehouse()} is {@code 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 {@code supportsStockWarehouseAssignment()} is {@code 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 {@code supportsStockSmartWarehouse()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsStockHierarchy()} is {@code 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 {@code supportsStockHierarchy()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsStockHierarchyDesign()} is {@code 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 {@code supportsStockHierarchyDesign()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsModelLookup()} is {@code 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 {@code supportsModelLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsModelQuery()} is {@code 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 {@code supportsModelQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsModelSearch()} is {@code 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 {@code supportsModelSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsModelAdmin()} is {@code 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 {@code supportsModelAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsModelNotification()} is {@code 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 {@code supportsModelNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsModelWarehouse()} is {@code 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 {@code supportsModelWarehouseAssignment()} is {@code 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 {@code supportsModelSmartWarehouse()} and {@code supportsVisibleFederation()} are {@code true}

getInventoryLookupSession

InventoryLookupSession getInventoryLookupSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the inventory lookup service.

Parameters:

proxy - proxy

Returns:

an InventoryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsInventoryLookup()} is {@code 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:

an 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 {@code supportsInventoryLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInventoryQuery()} is {@code 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 {@code supportsInventoryQuery()} and {@code supportsVisibleFederation()} are {@code true}

getInventorySearchSession

InventorySearchSession getInventorySearchSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the inventory search service.

Parameters:

proxy - proxy

Returns:

an InventorySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventorySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsInventorySearch()} is {@code 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:

an 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 {@code supportsInventorySearch()} and {@code supportsVisibleFederation()} are {@code true}

getInventoryAdminSession

InventoryAdminSession getInventoryAdminSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the inventory administration service.

Parameters:

proxy - proxy

Returns:

an InventoryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsInventoryAdmin()} is {@code 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:

an 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 {@code supportsInventoryAdmin()} and {@code supportsVisibleFederation()} are {@code 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:

an 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 {@code supportsInventoryNotification()} is {@code 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:

an 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 {@code supportsInventoryNotification()} and {@code supportsVisibleFederation()} are {@code true}

getInventoryWarehouseSession

InventoryWarehouseSession getInventoryWarehouseSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession to lookup inventory/catalog mappings.

Parameters:

proxy - proxy

Returns:

an InventoryCatalogSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryCatalog() is false

Compliance:

optional - This method must be implemented if {@code supportsInventoryCatalog()} is {@code true} .

getInventoryWarehouseAssignmentSession

InventoryWarehouseAssignmentSession getInventoryWarehouseAssignmentSession(Proxy proxy)
                                                                    throws OperationFailedException

Gets the OsidSession associated with assigning inventories to warehouses.

Parameters:

proxy - proxy

Returns:

an InventoryCatalogAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryCatalogAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsInventoryCatalogAssignment()} is {@code 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 {@code supportsInventorySmartWarehouse()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsWarehouseLookup()} is {@code 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 {@code supportsWarehouseQuery()} is {@code 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 {@code supportsWarehouseSearch()} is {@code 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 {@code supportsWarehouseAdmin()} is {@code 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 {@code supportsWarehouseNotification()} is {@code 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 {@code supportsWarehouseHierarchy()} is {@code 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 {@code supportsWarehouseHierarchyDesign()} is {@code true} .

getInventoryBatchProxyManager

InventoryBatchProxyManager getInventoryBatchProxyManager()
                                                  throws OperationFailedException

Gets the InventoryBatchProxyManager .

Returns:

an InventoryBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsInventoryBatch()} is {@code true} .

getInventoryShipmentProxyManager

InventoryShipmentProxyManager getInventoryShipmentProxyManager()
                                                        throws OperationFailedException

Gets the InventoryShipmentProxyManager .

Returns:

an InventoryShipmentProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryShipment() is false

Compliance:

optional - This method must be implemented if {@code supportsInventoryShipment()} is {@code true} .