public interface StockSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
StockQueryInspector |
getStockQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
StockList |
getStocks()
Gets the stock list resulting from a search.
|
StockSearchResultsRecord |
getStockSearchResultsRecord(Type stockSearchRecordType)
Gets the stock search results record corresponding to the given stock
search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
StockList getStocks()
IllegalStateException
- the stock list has already been
retrievedmandatory
- This method must be implemented. StockQueryInspector getStockQueryInspector()
mandatory
- This method must be implemented. StockSearchResultsRecord getStockSearchResultsRecord(Type stockSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.stockSearchRecordType
- a stock search record typeNullArgumentException
- stockSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(stockSearchRecordType)
is false
mandatory
- This method must be implemented.