OSID - osid.inventory.StockLookupSession Service Interface Definition

Interface	osid.inventory.StockLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving stocks. 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 warehouse view: All stock methods in this session operate, retrieve and pertain to stocks defined explicitly in the current warehouse. Using an isolated view is useful for managing `Stocks` with the `StockAdminSession.` federated warehouse view: All stock lookup methods in this session operate, retrieve and pertain to all stocks defined in this warehouse and any other stocks implicitly available in this warehouse through warehouse inheritence. The methods `useFederatedWarehouseView()` and `useIsolatedWarehouseView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getWarehouseId
Description	Gets the `Warehouse` `Id` associated with this session.
Return	`osid.id.Id`		the `Warehouse Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouse
Description	Gets the `Warehouse` associated with this session.
Return	`osid.inventory.Warehouse`		the warehouse
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupStocks
Description	Tests if this user can perform `Stock` 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	useComparativeStockView
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	usePlenaryStockView
Description	A complete view of the `Stock` 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	useFederatedWarehouseView
Description	Federates the view for methods in this session. A federated view will include stocks in catalogs which are children of this catalog in the warehouse hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedWarehouseView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this warehouse only.
Compliance	`mandatory`		This method is must be implemented.
Method	getStock
Description	Gets the `Stock` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Stock` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Stock` and retained for compatibility.
Parameters	`osid.id.Id`	`stockId`	the `Id` of the `Stock` to retrieve
Return	`osid.inventory.Stock`		the returned `Stock`
Errors	NOT_FOUND		no `Stock` found with the given `Id`
	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStocksByIds
Description	Gets a `StockList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the stocks 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 `Stocks` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`stockIds`	the list of `Ids` to retrieve
Return	`osid.inventory.StockList`		the returned `Stock` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`stockIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStocksByGenusType
Description	Gets a `StockList` corresponding to the given stock genus `Type` which does not include stocks of types derived from the specified `Type.` In plenary mode, the returned list contains all known stocks or an error results. Otherwise, the returned list may contain only those stocks that are accessible through this session.
Parameters	`osid.type.Type`	`stockGenusType`	a stock genus type
Return	`osid.inventory.StockList`		the returned `Stock` list
Errors	NULL_ARGUMENT		`stockGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStocksByParentGenusType
Description	Gets a `StockList` corresponding to the given stock genus `Type` and include any additional stocks with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known stocks or an error results. Otherwise, the returned list may contain only those stocks that are accessible through this session.
Parameters	`osid.type.Type`	`stockGenusType`	a stock genus type
Return	`osid.inventory.StockList`		the returned `Stock` list
Errors	NULL_ARGUMENT		`stockGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStocksByRecordType
Description	Gets a `StockList` containing the given stock record `Type.` In plenary mode, the returned list contains all known stocks or an error results. Otherwise, the returned list may contain only those stocks that are accessible through this session.
Parameters	`osid.type.Type`	`stockRecordType`	a stock record type
Return	`osid.inventory.StockList`		the returned `Stock` list
Errors	NULL_ARGUMENT		`stockRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStocksBySKU
Description	Gets a `StockList` containing for the given SKU. In plenary mode, the returned list contains all known stocks or an error results. Otherwise, the returned list may contain only those stocks that are accessible through this session.
Parameters	`string`	`sku`	a stock keeping unit
Return	`osid.inventory.StockList`		the returned `Stock` list
Errors	NULL_ARGUMENT		`sku` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getStocks
Description	Gets all `Stocks.` In plenary mode, the returned list contains all known stocks or an error results. Otherwise, the returned list may contain only those stocks that are accessible through this session.
Return	`osid.inventory.StockList`		a list of `Stocks`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.