| Interface | osid.ordering.PriceSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Used By | osid.ordering.PriceSearchSession | ||
| Description |
The search interface for governing price searches. | ||
| Method | searchAmongPrices | ||
| Description |
Execute this search among the given list of prices. | ||
| Parameters | osid.id.IdList | priceIds | list of prices |
| Errors | NULL_ARGUMENT | priceIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderPriceResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.ordering.PriceSearchOrder | priceSearchOrder | price search order |
| Errors | NULL_ARGUMENT | priceSearchOrder is null | |
| UNSUPPORTED | priceSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getPriceSearchRecord | ||
| Description |
Gets the price search record corresponding to the
given price search record | ||
| Parameters | osid.type.Type | priceSearchRecordType | a price search record type |
| Return | osid.ordering.records.PriceSearchRecord | the price search record | |
| Errors | NULL_ARGUMENT | priceSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(priceSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |