OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
ordering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.ordering.OrderSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing order searches. | ||
| Method | searchAmongOrders | ||
| Description |
Execute this search among the given list of orders. | ||
| Parameters | osid.id.IdList | orderIds | list of orders |
| Errors | NULL_ARGUMENT | orderIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderOrderResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.ordering.OrderSearchOrder | orderSearchOrder | order search order |
| Errors | NULL_ARGUMENT | orderSearchOrder is null | |
| UNSUPPORTED | orderSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getOrderSearchRecord | ||
| Description |
Gets the order record corresponding to the given order
search record | ||
| Parameters | osid.type.Type | orderSearchRecordType | a order search record type |
| Return | osid.ordering.records.OrderSearchRecord | the order search record | |
| Errors | NULL_ARGUMENT | orderSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(orderSearchRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |