OSID - osid.ordering.MyOrderSession Service Interface Definition

Interface	osid.ordering.MyOrderSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving orders. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated store view: All order methods in this session operate, retrieve and pertain to orders defined explicitly in the current store. Using an isolated view is useful for managing orders with the `OrderAdminSession.` federated store view: All order lookup methods in this session operate, retrieve and pertain to all orders defined in this store and any other stores implicitly available in this store through store inheritence. The methods `useFederatedStoreView()` and `useIsolatedStoreView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getStoreId
Description	Gets the `Store` `Id` associated with this session.
Return	`osid.id.Id`	the `Store Id` associated with this session
Compliance	`mandatory`	This method must be implemented.
Method	getStore
Description	Gets the `Store` associated with this session.
Return	`osid.ordering.Store`	the store
Errors	OPERATION_FAILED	unable to complete request
Errors	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 `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer these operations.
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 `Order` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
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
Errors	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
Errors	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
Errors	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
Errors	PERMISSION_DENIED	authorization failure
Compliance	`mandatory`	This method must be implemented.