public interface WarehouseSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
WarehouseQueryInspector |
getWarehouseQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
WarehouseList |
getWarehouses()
Gets the warehouse list resulting from a search.
|
WarehouseSearchResultsRecord |
getWarehouseSearchResultsRecord(Type warehouseSearchRecordType)
Gets the warehouse search results record corresponding to the given
warehouse search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
WarehouseList getWarehouses()
IllegalStateException
- the warehouse list has already
been retrievedmandatory
- This method must be implemented. WarehouseQueryInspector getWarehouseQueryInspector()
mandatory
- This method must be implemented. WarehouseSearchResultsRecord getWarehouseSearchResultsRecord(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.