OSID - osid.ordering.ProductLookupSession Service Interface Definition

Interface	osid.ordering.ProductLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Product` 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 products defined explicitly in the current store. Using an isolated view is useful for managing products with the `ProductAdminSession.` federated store view: All product lookup methods in this session operate, retrieve and pertain to all products defined in this store and any other stores implicitly available in this store through store inheritence.
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	canLookupProducts
Description	Tests if this user can perform `Product` 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	useComparativeProductView
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	usePlenaryProductView
Description	A complete view of the `Product` 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 products 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	getProduct
Description	Gets the `Product` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Product` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Product` and retained for compatibility.
Parameters	`osid.id.Id`	`productId`	`Id` of the `Product`
Return	`osid.ordering.Product`		the product
Errors	NOT_FOUND		`productId` not found
	NULL_ARGUMENT		`productId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getProductsByIds
Description	Gets a `ProductList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the products 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 `Products` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`productIds`	the list of `Ids` to retrieve
Return	`osid.ordering.ProductList`		the returned `Product` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`productIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProductsByGenusType
Description	Gets a `ProductList` corresponding to the given product genus `Type` which does not include products of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known products or an error results. Otherwise, the returned list may contain only those products that are accessible through this session.
Parameters	`osid.type.Type`	`productGenusType`	a product genus type
Return	`osid.ordering.ProductList`		the returned `Product` list
Errors	NULL_ARGUMENT		`productGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProductsByParentGenusType
Description	Gets a `ProductList` corresponding to the given product genus `Type` and include any additional products with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known products or an error results. Otherwise, the returned list may contain only those products that are accessible through this session.
Parameters	`osid.type.Type`	`productGenusType`	a product genus type
Return	`osid.ordering.ProductList`		the returned `Product` list
Errors	NULL_ARGUMENT		`productGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProductsByRecordType
Description	Gets a `ProductList` containing the given repository record `Type.` In plenary mode, the returned list contains all known products or an error results. Otherwise, the returned list may contain only those products that are accessible through this session.
Parameters	`osid.type.Type`	`productRecordType`	a product record type
Return	`osid.ordering.ProductList`		the returned `Product` list
Errors	NULL_ARGUMENT		`productRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProductsByCode
Description	Gets the `Product` specified by its product code.
Parameters	`string`	`code`	a product code
Return	`osid.ordering.ProductList`		the product
Errors	NOT_FOUND		`code` not found
	NULL_ARGUMENT		`code` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getProductsByPriceSchedule
Description	Gets a `ProductList` containing the given price schedule. In plenary mode, the returned list contains all known products or an error results. Otherwise, the returned list may contain only those products that are accessible through this session.
Parameters	`osid.id.Id`	`priceScheduleId`	a price schedule `Id`
Return	`osid.ordering.ProductList`		the product list
Errors	NULL_ARGUMENT		`priceScheduleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getProducts
Description	Gets all `Products.` In plenary mode, the returned list contains all known products or an error results. Otherwise, the returned list may contain only those products that are accessible through this session.
Return	`osid.ordering.ProductList`		a list of `Products`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.