| Interface | osid.inventory.StockSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidFederateableSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderBySKU | ||
| Description |
Specifies a preference for ordering the result set by the sku. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByLocationDescription | ||
| Description |
Specifies a preference for ordering the result set by the location description. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStockSearchOrderRecord | ||
| Description |
Gets the stock search order record corresponding to the
given stock record | ||
| Parameters | osid.type.Type | stockRecordType | a stock record type |
| Return | osid.inventory.records.StockSearchOrderRecord | the stock search order record | |
| Errors | NULL_ARGUMENT | stockRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(stockRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |