Interface | osid.ordering.OrderLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving orders. This lookup session defines several views:
The methods | ||
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 | canLookupOrders | ||
Description |
Tests if this user can lookup orders. 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 order lookup methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeOrderView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryOrderView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedStoreView | ||
Description |
Federates the view for methods in this session. A federated view will include orders 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 | getOrder | ||
Description |
Gets the | ||
Parameters | osid.id.Id | orderId | the Id of the Order to retrieve |
Return | osid.ordering.Order | the returned Order | |
Errors | NOT_FOUND | no Order found with the given Id | |
NULL_ARGUMENT | orderId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrdersByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | orderIds | the list of Ids to retrieve |
Return | osid.ordering.OrderList | the returned Order list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | orderIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrdersByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | orderGenusType | an order genus type |
Return | osid.ordering.OrderList | the returned Order list | |
Errors | NULL_ARGUMENT | orderGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrdersByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | orderGenusType | an order genus type |
Return | osid.ordering.OrderList | the returned Order list | |
Errors | NULL_ARGUMENT | orderGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrdersByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | orderRecordType | an order record type |
Return | osid.ordering.OrderList | the returned Order list | |
Errors | NULL_ARGUMENT | orderRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrdersByCustomer | ||
Description |
Gets a list of all orders corresponding to a customer
| ||
Parameters | osid.id.Id | resourceId | the Id of the customer |
Return | osid.ordering.OrderList | the returned OrderList | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrdersByDate | ||
Description |
Gets a list of all orders corresponding to a date range. Entries are returned with a submitted date that falsl between the requested dates inclusive. In plenary mode, the returned list contains all known orders or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. | ||
Parameters | osid.calendaring.DateTime | from | from date |
osid.calendaring.DateTime | to | to date | |
Return | osid.ordering.OrderList | the returned OrderList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrdersByCustomerAndDate | ||
Description |
Gets a list of all orders corresponding to a customer
| ||
Parameters | osid.id.Id | resourceId | the Id of the customer |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.ordering.OrderList | the returned OrderList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | resourceId, from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrdersForProduct | ||
Description |
Gets a list of all orders with an item for a product. Entries are returned with submit dates that fall between the requested dates inclusive. In plenary mode, the returned list contains all known orders or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. | ||
Parameters | osid.id.Id | productId | a product Id |
Return | osid.ordering.OrderList | the returned OrderList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | productId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrdersForProductAndDate | ||
Description |
Gets a list of all orders with items for a product
| ||
Parameters | osid.id.Id | productId | a product Id |
osid.calendaring.DateTime | from | from date | |
osid.calendaring.DateTime | to | to date | |
Return | osid.ordering.OrderList | the returned OrderList | |
Errors | INVALID_ARGUMENT | to is less than from | |
NULL_ARGUMENT | productId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOrders | ||
Description |
Gets all orders. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. | ||
Return | osid.ordering.OrderList | a list of orders | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOpenOrders | ||
Description |
Gets all submitted and not closed orders. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. | ||
Return | osid.ordering.OrderList | a list of orders | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getClosedOrders | ||
Description |
Gets all closed orders. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session. | ||
Return | osid.ordering.OrderList | a list of orders | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |