OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
ordering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.ordering.ProductSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getProducts | ||
| Description |
Gets the product list resulting from a search. | ||
| Return | osid.ordering.ProductList | the product list | |
| Errors | ILLEGAL_STATE | list has already been retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProductQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terns used in the search. | ||
| Return | osid.ordering.ProductQueryInspector | the query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProductSearchResultsRecord | ||
| Description |
Gets the product search results record corresponding to the given product search record Type. This method is used to retrieve an object implementing the requested recor. | ||
| Parameters | osid.type.Type | productSearchRecordType | an product search record type |
| Return | osid.ordering.records.ProductSearchResultsRecord | the product search results record | |
| Errors | NULL_ARGUMENT | ProductSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(productSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |