| Interface | osid.ordering.ProductSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing product searches. | ||
| Method | searchAmongProducts | ||
| Description |
Execute this search among the given list of products. | ||
| Parameters | osid.id.IdList | productIds | list of products |
| Errors | NULL_ARGUMENT | productIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderProductResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.ordering.ProductSearchOrder | productSearchOrder | product search order |
| Errors | NULL_ARGUMENT | productSearchOrder is null | |
| UNSUPPORTED | productSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getProductSearchRecord | ||
| Description |
Gets the product search record corresponding to the
given product search record | ||
| Parameters | osid.type.Type | productSearchRecordType | an product search record type |
| Return | osid.ordering.records.ProductSearchRecord | the product search 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. | |