Interface | osid.inventory.WarehouseSearchSession | ||
---|---|---|---|
Implements | osid.inventory.WarehouseQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
warehouses may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getWarehouseSearch | ||
Description |
Gets a warehouse search. | ||
Return | osid.inventory.WarehouseSearch | the warehouse search | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouseSearchOrder | ||
Description |
Gets a warehouse search order. The | ||
Return | osid.inventory.WarehouseSearchOrder | the warehouse search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehousesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.inventory.WarehouseQuery | warehouseQuery | the warehouse query |
osid.inventory.WarehouseSearch | warehouseSearch | the warehouse search | |
Return | osid.inventory.WarehouseSearchResults | the warehouse search results | |
Errors | NULL_ARGUMENT | warehouseQuery or warehouseSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | warehouseQuery or warehouseSearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouseQueryFromInspector | ||
Description |
Gets a warehouse query from an inspector. The inspector
is available from a | ||
Parameters | osid.inventory.WarehouseQueryInspector | warehouseQueryInspector | a warehouse query inspector |
Return | osid.inventory.WarehouseQuery | the warehouse query | |
Errors | NULL_ARGUMENT | warehouseQueryInspector is null | |
UNSUPPORTED | warehouseQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |