| Interface | osid.ordering.PriceScheduleSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidAggregateableSearchOrder | |||
| Used By | osid.ordering.PriceScheduleSearchSession | ||
osid.ordering.PriceScheduleSmartStoreSession | |||
osid.ordering.PriceSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByListPrice | ||
| Description |
Specifies a preference for ordering the result set by the list price. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByRecurring | ||
| Description |
Specifies a preference for ordering the result set by the recurring flag. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByRecurringInterval | ||
| Description |
Specifies a preference for ordering the result set by the recurring interval. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPriceScheduleSearchOrderRecord | ||
| Description |
Gets the price schedule search order record corresponding to the given price record Type. Multiple retrievals return the same underlying object. | ||
| Parameters | osid.type.Type | priceScheduleRecordType | a price schedule record type |
| Return | osid.ordering.records.PriceScheduleSearchOrderRecord | the price schedule search order record | |
| Errors | NULL_ARGUMENT | priceScheduleRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(priceScheduleRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |