OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
ordering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.ordering.PriceScheduleSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getPriceSchedules | ||
| Description |
Gets the price schedule list resulting from a search. | ||
| Return | osid.ordering.PriceScheduleList | the price schedule list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPriceScheduleQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.ordering.PriceScheduleQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPriceScheduleSearchResultsRecord | ||
| Description |
Gets the price schedule search results record corresponding to the given price schedule search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | priceSearchRecordType | an price schedule search record type |
| Return | osid.ordering.records.PriceScheduleSearchResultsRecord | the price schedule search results record | |
| Errors | NULL_ARGUMENT | PriceScheduleSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(priceScheduleSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |