Interface | osid.ordering.OrderQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
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 | getStoreId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Store Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getStore | ||
Description |
Gets the | ||
Return | osid.ordering.Store | the store | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchOrders | ||
Description |
Tests if this user can perform susbcription searches. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known all methods in this session will result in a | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedStoreView | ||
Description |
Federates the view for methods in this session. A federated view will include entries in stores which are children of this store in the store hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedStoreView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this store only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getOrderQuery | ||
Description |
Gets an order query. | ||
Return | osid.ordering.OrderQuery | the order query | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrdersByQuery | ||
Description |
Gets a list of orders matching the given order query. | ||
Parameters | osid.ordering.OrderQuery | orderQuery | the order query |
Return | osid.ordering.OrderList | the returned OrderList | |
Errors | NULL_ARGUMENT | orderQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | orderQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |