Interface | osid.inventory.ItemSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByStock | ||
Description |
Specifies a preference for ordering the result set by the stock. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsStockSearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a stock search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStockSearchOrder | ||
Description |
Gets the search order for a stock. | ||
Return | osid.inventory.StockSearchOrder | the stock search order | |
Errors | UNIMPLEMENTED | supportsStockSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsStockSearchOrder()
is true. | |
Method | orderByPropertyTag | ||
Description |
Specifies a preference for ordering the result set by the property tag. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderBySerialNumber | ||
Description |
Specifies a preference for ordering the result set by the serial number. | ||
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 | orderByLocation | ||
Description |
Specifies a preference for ordering the result set by the location. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsLocationSearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a location search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLocationSearchOrder | ||
Description |
Gets the location order for a stock. | ||
Return | osid.mapping.LocationSearchOrder | the location search order | |
Errors | UNIMPLEMENTED | supportsLocationSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsLocationSearchOrder()
is true. | |
Method | orderByItem | ||
Description |
Specifies a preference for ordering the result set by the containing item. | ||
Parameters | osid.SearchOrderStyle | style | a search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsItemSearchOrder | ||
Description |
Tests if an | ||
Return | boolean | true if an item search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getItemSearchOrder | ||
Description |
Gets the item order for a stock. | ||
Return | osid.inventory.ItemSearchOrder | the location search order | |
Errors | UNIMPLEMENTED | supportsItemSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsItemSearchOrder()
is true. | |
Method | getItemSearchOrderRecord | ||
Description |
Gets the item search order record corresponding to the
given item record | ||
Parameters | osid.type.Type | itemRecordType | an item record type |
Return | osid.inventory.records.ItemSearchOrderRecord | the item search order record | |
Errors | NULL_ARGUMENT | itemRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(itemRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |