Interface | osid.inventory.ModelSmartWarehouseSession | ||
---|---|---|---|
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 | getModelQuery | ||
Description |
Gets a model query. | ||
Return | osid.inventory.ModelQuery | the model query | |
Compliance | mandatory | This method must be implemented. | |
Method | getModelSearchOrder | ||
Description |
Gets a model search order. | ||
Return | osid.inventory.ModelSearchOrder | the model search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyModelQuery | ||
Description |
Applies a model query to this warehouse. | ||
Parameters | osid.inventory.ModelQuery | modelQuery | the model query |
Errors | NULL_ARGUMENT | modelQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | modelQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectModelQuery | ||
Description |
Gets a model query inspector for this warehouse. | ||
Return | osid.inventory.ModelQueryInspector | the model query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyModelSequencing | ||
Description |
Applies a model search order to this warehouse. | ||
Parameters | osid.inventory.ModelSearchOrder | modelSearchOrder | the model search order |
Errors | NULL_ARGUMENT | modelSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | modelSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getModelQueryFromInspector | ||
Description |
Gets a model query from an inspector. | ||
Parameters | osid.inventory.ModelQueryInspector | modelQueryInspector | a query inspector |
Return | osid.inventory.ModelQuery | the model query | |
Errors | NULL_ARGUMENT | modelQueryInspector is null | |
UNSUPPORTED | modelQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |