Interface | osid.inventory.WarehouseQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
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 | canSearchWarehouses | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouseQuery | ||
Description |
Gets a warehouse query. | ||
Return | osid.inventory.WarehouseQuery | the warehouse query | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehousesByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.inventory.WarehouseQuery | warehouseQuery | the warehouse query |
Return | osid.inventory.WarehouseList | the returned WarehouseList | |
Errors | NULL_ARGUMENT | warehouseQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | warehouseQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |