| Interface | osid.ordering.ProductSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByCode | ||
| Description |
Specifies a preference for ordering the result set by the code. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByAvailability | ||
| Description |
Specifies a preference for ordering the result set by the availability. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProductSearchOrderRecord | ||
| Description |
Gets the product search record order corresponding to the given product record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | productRecordType | an product record type |
| Return | osid.ordering.records.ProductSearchOrderRecord | the product search order record | |
| Errors | NULL_ARGUMENT | productRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(productRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |