| Interface | osid.inventory.StockSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description | 
                 The search interface for governing stock searches.  | ||
| Method | searchAmongStocks | ||
| Description | 
                     Execute this search among the given list of stocks.  | ||
| Parameters | osid.id.IdList | stockIds | list of stocks | 
| Errors | NULL_ARGUMENT |  stockIds  is  null   |                 |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderStockResults | ||
| Description | 
                     Specify an ordering to the search results.  | ||
| Parameters | osid.inventory.StockSearchOrder | stockSearchOrder | stock search order | 
| Errors | NULL_ARGUMENT |  stockSearchOrder  is  null   |                 |
| UNSUPPORTED |  stockSearchOrder  is not of this service  |                 ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getStockSearchRecord | ||
| Description | 
                     Gets the stock search record corresponding to the given 
                    stock search record   | ||
| Parameters | osid.type.Type | stockSearchRecordType | a stock search record type | 
| Return | osid.inventory.records.StockSearchRecord | the stock search record | |
| Errors | NULL_ARGUMENT |  stockSearchRecordType  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED |  hasRecordType(stockSearchRecordType)  is  false   |                 ||
| Compliance | mandatory | This method must be implemented. | |