Interface | osid.inventory.StockSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getStocks | ||
Description |
Gets the stock list resulting from a search. | ||
Return | osid.inventory.StockList | the stock list | |
Errors | ILLEGAL_STATE | the stock list has already been retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getStockQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.inventory.StockQueryInspector | the query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getStockSearchResultsRecord | ||
Description |
Gets the stock search results record corresponding to
the given stock search record | ||
Parameters | osid.type.Type | stockSearchRecordType | a stock search record type |
Return | osid.inventory.records.StockSearchResultsRecord | the stock search results 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. |