OSID - osid.ordering.OrderLookupSession Service Interface Definition

Interface	osid.ordering.OrderLookupSession
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	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 `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 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 `Order` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Order` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Order` and retained for compatibility.
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 `OrderList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the entries specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible entries may be omitted from the list and may present the elements in any order including returning a unique set.
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 `OrderList` corresponding to the given order genus `Type` which does not include orders of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known orders or an error results. Otherwise, the returned list may contain only those orders that are accessible through this session.
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 `OrderList` corresponding to the given order genus `Type` and include any additional orders with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known orders or an error results. Otherwise, the returned list may contain only those orders that are accessible through this session.
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 `OrderList` containing the given repository record `Type.` In plenary mode, the returned list contains all known orders or an error results. Otherwise, the returned list may contain only those orders that are accessible through this session.
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 `Id.` 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`	`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
Parameters	`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 `Id` and date range. 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`	`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 `Id` and date range. 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`
	`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
Errors	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
Errors	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
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.