| Interface | osid.ordering.OrderItemSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidRelationshipSearchOrder | ||
| Used By | osid.ordering.OrderItemSearchSession | ||
osid.ordering.OrderItemSmartStoreSession | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByOrder | ||
| Description |
Specifies a preference for ordering the result set by the order. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsOrderSearchOrder | ||
| Description |
Tests if an order order is available. | ||
| Return | boolean | true if an order order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrderSearchOrder | ||
| Description |
Gets the order order. | ||
| Return | osid.ordering.OrderSearchOrder | the order search order | |
| Errors | UNIMPLEMENTED | supportsOrderSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsOrderSearchOrder()
is true. | |
| Method | orderByDerived | ||
| Description |
Specifies a preference for ordering the result set by the derived flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByProduct | ||
| Description |
Specifies a preference for ordering the result set by the product. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsProductSearchOrder | ||
| Description |
Tests if a product order is available. | ||
| Return | boolean | true if a product order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProductSearchOrder | ||
| Description |
Gets the product order. | ||
| Return | osid.ordering.ProductSearchOrder | the product search order | |
| Errors | UNIMPLEMENTED | supportsProductSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsProductSearchOrder() is true. | |
| Method | orderByQuantity | ||
| Description |
Specifies a preference for ordering the result set by the quantity. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrderItemSearchOrderRecord | ||
| Description |
Gets the order item search record order corresponding to the given order item record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | orderItemRecordType | an order item record type |
| Return | osid.ordering.records.OrderItemSearchOrderRecord | the order item search order record | |
| Errors | NULL_ARGUMENT | orderItemRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(itemRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |