Interface | osid.inventory.ItemSmartWarehouseSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. An 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 | getItemQuery | ||
Description |
Gets an item query. | ||
Return | osid.inventory.ItemQuery | the item query | |
Compliance | mandatory | This method must be implemented. | |
Method | getItemSearchOrder | ||
Description |
Gets an item search order. | ||
Return | osid.inventory.ItemSearchOrder | the item search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyItemQuery | ||
Description |
Applies an item query to this warehouse. | ||
Parameters | osid.inventory.ItemQuery | itemQuery | the item query |
Errors | NULL_ARGUMENT | itemQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | itemQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectItemQuery | ||
Description |
Gets an item query inspector for this warehouse. | ||
Return | osid.inventory.ItemQueryInspector | the item query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyItemSequencing | ||
Description |
Applies an item search order to this warehouse. | ||
Parameters | osid.inventory.ItemSearchOrder | itemSearchOrder | the item search order |
Errors | NULL_ARGUMENT | itemSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | itemSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemQueryFromInspector | ||
Description |
Gets an item query from an inspector. | ||
Parameters | osid.inventory.ItemQueryInspector | itemQueryInspector | a query inspector |
Return | osid.inventory.ItemQuery | the item query | |
Errors | NULL_ARGUMENT | itemQueryInspector is null | |
UNSUPPORTED | itemQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |