OSID - osid.ordering.OrderItemLookupSession Service Interface Definition

Interface	osid.ordering.OrderItemLookupSession
Implements	`osid.OsidSession`
Used By	`osid.ordering.OrderingManager`
Used By	`osid.ordering.OrderingProxyManager`
Description	This session provides methods for retrieving `OrderItem` objects. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated store view: All order methods in this session operate, retrieve and pertain to order items defined explicitly in the current store. Using an isolated view is useful for managing order items with the `OrderItemAdminSession`. federated store view: All order item lookup methods in this session operate, retrieve and pertain to all order items defined in this store and any other stores implicitly available in this store through store inheritence. Like all `OsidSessions`, `OrderItemLookupSessions` are dedicated to single processing threads and a single authenticated user.
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	canLookupOrderItems
Description	Tests if this user can perform `OrderItem` lookups. 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 not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeOrderItemView
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 must be implemented.
Method	usePlenaryOrderItemView
Description	A complete view of the `OrderItem` 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 must be implemented.
Method	useFederatedStoreView
Description	Federates the view for methods in this session. A federated view will include order items in stores which are children of this store in the store hierarchy.
Compliance	`mandatory`		This method 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 must be implemented.
Method	getOrderItem
Description	Gets the `OrderItem` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `OrderItem` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `OrderItem` and retained for compatibility.
Parameters	`osid.id.Id`	`orderItemId`	`Id` of the `OrderItem`
Return	`osid.ordering.OrderItem`		the order item
Errors	NOT_FOUND		`orderItemId` not found
	NULL_ARGUMENT		`orderItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemsByIds
Description	Gets an `OrderItemList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the order items 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 `OrderItems` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`orderItemIds`	the list of `Ids` to retrieve
Return	`osid.ordering.OrderItemList`		the returned `OrderItem` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`orderItemIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemsByGenusType
Description	Gets an `OrderItemList` corresponding to the given order item genus `Type` which does not include order items of genus types derived from the specified `Type`.In plenary mode, the returned list contains all known order items or an error results. Otherwise, the returned list may contain only those order items that are accessible through this session.
Parameters	`osid.type.Type`	`orderItemGenusType`	an order item genus type
Return	`osid.ordering.OrderItemList`		the returned `OrderItem` list
Errors	NULL_ARGUMENT		`orderItemGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemsByParentGenusType
Description	Gets an `OrderItemList` corresponding to the given order item genus `Type` and include any additional order items with genus types derived from the specified `Type`.In plenary mode, the returned list contains all known order items or an error results. Otherwise, the returned list may contain only those order items that are accessible through this session.
Parameters	`osid.type.Type`	`orderItemGenusType`	an order item genus type
Return	`osid.ordering.OrderItemList`		the returned `OrderItem` list
Errors	NULL_ARGUMENT		`orderItemGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemsByRecordType
Description	Gets an `OrderItemList` containing the given repository record `Type`. In plenary mode, the returned list contains all known order items or an error results. Otherwise, the returned list may contain only those order items that are accessible through this session.
Parameters	`osid.type.Type`	`orderItemRecordType`	an order item record type
Return	`osid.ordering.OrderItemList`		the returned `OrderItem` list
Errors	NULL_ARGUMENT		`orderItemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemsForOrder
Description	Gets an `OrderItemList` for the given order. In plenary mode, the returned list contains all known order items or an error results. Otherwise, the returned list may contain only those order items that are accessible through this session.
Parameters	`osid.id.Id`	`orderId`	an `Id` of an `Order`
Return	`osid.ordering.OrderItemList`		the returned `OrderItemList`
Errors	NULL_ARGUMENT		`orderId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItems
Description	Gets all `OrderItems`. In plenary mode, the returned list contains all known order items or an error results. Otherwise, the returned list may contain only those order items that are accessible through this session.
Return	`osid.ordering.OrderItemList`		a list of `OrderItems`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.