Interface | osid.inventory.StockSearchSession | ||
---|---|---|---|
Implements | osid.inventory.StockQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Stocks may have a query record indicated by their
respective record types. The queryrecord is accessed via the
| ||
Method | getStockSearch | ||
Description |
Gets a stock search. | ||
Return | osid.inventory.StockSearch | the stock search | |
Compliance | mandatory | This method must be implemented. | |
Method | getStockSearchOrder | ||
Description |
Gets a stock search order. The | ||
Return | osid.inventory.StockSearchOrder | the stock search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getStocksBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.inventory.StockQuery | stockQuery | the stock query |
osid.inventory.StockSearch | stockSearch | the stock search | |
Return | osid.inventory.StockSearchResults | the stock search results | |
Errors | NULL_ARGUMENT | stockQuery or stockSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | stockQuery or stockSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStockQueryFromInspector | ||
Description |
Gets a stock query from an inspector. The inspector is
available from a | ||
Parameters | osid.assessment.ItemQueryInspector | stockQueryInspector | a stock query inspector |
Return | osid.inventory.StockQuery | the stock query | |
Errors | NULL_ARGUMENT | stockQueryInspector is null | |
UNSUPPORTED | stockQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |