Interface | osid.ordering.MyOrderSession | ||
---|---|---|---|
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 | canLookupMyOrders | ||
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 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 | getOrders | ||
Description |
Gets all orders for the subscriber related to the current agent. 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. In both cases, the order of the set is not specifed. | ||
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 | getUnsubmittedOrders | ||
Description |
Gets all orders not yet submitted for the customer related to this agent. 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. In both cases, the order of the set is not specifed. | ||
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 for the customer related to this agent. 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. In both cases, the order of the set is not specifed. | ||
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 for the customer related to this agent. 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. In both cases, the order of the set is not specifed. | ||
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. |