public interface WarehouseSearch extends OsidSearch
The search interface for governing warehouse searches.
Modifier and Type | Method and Description |
---|---|
WarehouseSearchRecord |
getWarehouseSearchRecord(Type warehouSesearchRecordType)
Gets the warehouse search record corresponding to the given warehouse
search record
Type. |
void |
orderWarehouseResults(WarehouseSearchOrder warehouseSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongWarehouses(IdList warehouseIds)
Execute this search among the given list of warehouses.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongWarehouses(IdList warehouseIds)
warehouseIds
- list of warehousesNullArgumentException
- warehouseIds
is
null
mandatory
- This method must be implemented. void orderWarehouseResults(WarehouseSearchOrder warehouseSearchOrder)
warehouseSearchOrder
- warehouse search orderNullArgumentException
- warehousesearchOrder
is null
UnsupportedException
- warehousesearchOrder
is not of this servicemandatory
- This method must be implemented. WarehouseSearchRecord getWarehouseSearchRecord(Type warehouSesearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.warehouSesearchRecordType
- a warehouse search record typeNullArgumentException
-
warehouseSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(warehouseSearchRecordType)
is
false
mandatory
- This method must be implemented.