Interface | osid.ordering.OrderSearchSession | ||
---|---|---|---|
Implements | osid.ordering.OrderQuerySession | ||
Description |
This session provides methods for searching Orders may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getOrderSearch | ||
Description |
Gets an order search. | ||
Return | osid.ordering.OrderSearch | the order search | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrderSearchOrder | ||
Description |
Gets an order search order. The | ||
Return | osid.ordering.OrderSearchOrder | the order search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrdersBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.ordering.OrderQuery | orderQuery | the order query |
osid.ordering.OrderSearch | orderSearch | the order search | |
Return | osid.ordering.OrderSearchResults | the order search results | |
Errors | NULL_ARGUMENT | orderQuery or orderSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | orderQuery or orderSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrderQueryFromInspector | ||
Description |
Gets an entry query from an inspector. The inspector is
available from an | ||
Parameters | osid.ordering.OrderQueryInspector | orderQueryInspector | a query inspector |
Return | osid.ordering.OrderQuery | the order query | |
Errors | NULL_ARGUMENT | orderQueryInspector is null | |
UNSUPPORTED | orderQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |