Interface | osid.inventory.WarehouseSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing warehouse searches. | ||
Method | searchAmongWarehouses | ||
Description |
Execute this search among the given list of warehouses. | ||
Parameters | osid.id.IdList | warehouseIds | list of warehouses |
Errors | NULL_ARGUMENT | warehouseIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderWarehouseResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.inventory.WarehouseSearchOrder | warehouseSearchOrder | warehouse search order |
Errors | NULL_ARGUMENT | warehousesearchOrder is null | |
UNSUPPORTED | warehousesearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouseSearchRecord | ||
Description |
Gets the warehouse search record corresponding to the
given warehouse search record | ||
Parameters | osid.type.Type | warehouSesearchRecordType | a warehouse search record type |
Return | osid.inventory.records.WarehouseSearchRecord | the warehouse search record | |
Errors | NULL_ARGUMENT | warehouseSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(warehouseSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |