public interface StockSearch extends OsidSearch
The search interface for governing stock searches.
Modifier and Type | Method and Description |
---|---|
StockSearchRecord |
getStockSearchRecord(Type stockSearchRecordType)
Gets the stock search record corresponding to the given stock search
record
Type. |
void |
orderStockResults(StockSearchOrder stockSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongStocks(IdList stockIds)
Execute this search among the given list of stocks.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongStocks(IdList stockIds)
stockIds
- list of stocksNullArgumentException
- stockIds
is
null
mandatory
- This method must be implemented. void orderStockResults(StockSearchOrder stockSearchOrder)
stockSearchOrder
- stock search orderNullArgumentException
- stockSearchOrder
is null
UnsupportedException
- stockSearchOrder
is not of this servicemandatory
- This method must be implemented. StockSearchRecord getStockSearchRecord(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.