Interface | osid.inventory.StockSmartWarehouseSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getWarehouseId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Warehouse Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouse | ||
Description |
Gets the | ||
Return | osid.inventory.Warehouse | the warehouse | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartWarehouses | ||
Description |
Tests if this user can manage smart warehouses. A
return of true does not guarantee successful assessment. A
return of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart warehouse management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStockQuery | ||
Description |
Gets a stock query. | ||
Return | osid.inventory.StockQuery | the stock query | |
Compliance | mandatory | This method must be implemented. | |
Method | getStockSearchOrder | ||
Description |
Gets a stock search order. | ||
Return | osid.inventory.StockSearchOrder | the stock search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyStockQuery | ||
Description |
Applies a stock query to this warehouse. | ||
Parameters | osid.inventory.StockQuery | stockQuery | the stock query |
Errors | NULL_ARGUMENT | stockQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | stockQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectStockQuery | ||
Description |
Gets a stock query inspector for this warehouse. | ||
Return | osid.inventory.StockQueryInspector | the stock query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyStockSequencing | ||
Description |
Applies a stock search order to this warehouse. | ||
Parameters | osid.inventory.StockSearchOrder | stockSearchOrder | the stock search order |
Errors | NULL_ARGUMENT | stockSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | stockSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStockQueryFromInspector | ||
Description |
Gets a stock query from an inspector. | ||
Parameters | osid.inventory.StockQueryInspector | stockQueryInspector | a query inspector |
Return | osid.inventory.StockQuery | the stock query | |
Errors | NULL_ARGUMENT | stockQueryInspector is null | |
UNSUPPORTED | stockQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |