OSID - osid.ordering.OrderItemStoreSession Service Interface Definition

Interface	osid.ordering.OrderItemStoreSession
Implements	`osid.OsidSession`
Used By	`osid.ordering.OrderingManager`
Used By	`osid.ordering.OrderingProxyManager`
Description	This session provides methods to retrieve `OrderItem` to `Store` mappings. A `OrderItem` may appear in multiple `Stores`. Each `Store` may have its own authorizations governing who is allowed to look at it. 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 Like all `OsidSessions`, `OrderItemStoreSessions` are dedicated to single processing threads and a single authenticated user.
Method	canLookupOrderItemStoreMappings
Description	Tests if this user can perform lookups of order item/store mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a `PERMISSION_DENIED`. This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeStoreView
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	usePlenaryStoreView
Description	A complete view of the `OrderItem` and `Store` 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	getOrderItemIdsByStore
Description	Gets the list of OrderItem Ids associated with a `Store`.
Parameters	`osid.id.Id`	`storeId`	`Id` of a `Store`.
Return	`osid.id.IdList`		list of related order item `Ids`
Errors	NOT_FOUND		`storeId` is not found
	NULL_ARGUMENT		`storeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemsByStore
Description	Gets the list of `OrderItems` associated with a `Store`.
Parameters	`osid.id.Id`	`storeId`	`Id` of a `Store`
Return	`osid.ordering.OrderItemList`		list of related order items
Errors	NOT_FOUND		`storeId` is not found
	NULL_ARGUMENT		`storeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemIdsByStores
Description	Gets the list of `OrderItem Ids` corresponding to a list of `Store` objects.
Parameters	`osid.id.IdList`	`storeIds`	list of store `Ids`
Return	`osid.id.IdList`		list of order item `Ids`
Errors	NULL_ARGUMENT		`storeIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOrderItemsByStores
Description	Gets the list of `OrderItems` corresponding to a list of `Stores`.
Parameters	`osid.id.IdList`	`storeIds`	list of store `Ids`
Return	`osid.ordering.OrderItemList`		list of order items
Errors	NULL_ARGUMENT		`storeIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStoreIdsByOrderItem
Description	Gets the list of `Store` `Ids` mapped to a `OrderItem`.
Parameters	`osid.id.Id`	`orderItemId`	`Id` of a `OrderItem`
Return	`osid.id.IdList`		list of store `Ids`
Errors	NOT_FOUND		`orderItemId` is 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	getStoresByOrderItem
Description	Gets the list of `Store` objects mapped to an `OrderItem`.
Parameters	`osid.id.Id`	`orderItemId`	`Id` of a `OrderItem`
Return	`osid.ordering.StoreList`		list of stores
Errors	NOT_FOUND		`orderItemId` is not found
	NULL_ARGUMENT		`orderItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.