OSID - osid.inventory.InventoryLookupSession Service Interface Definition

Interface	osid.inventory.InventoryLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Inventory` objects. The `Inventory` represents a collection of items and models. 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 warehouse view: All inventory methods in this session operate, retrieve and pertain to inventories defined explicitly in the current warehouse. Using an isolated view is useful for managing `Inventories` with the `InventoryAdminSession.` federated warehouse view: All inventory methods in this session operate, retrieve and pertain to all inventories defined in this warehouse and any other inventories implicitly available in this warehouse through warehouse inheritence. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. 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	canLookupInventories
Description	Tests if this user can perform `Inventory` 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 opt not to 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	useComparativeInventoryView
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	usePlenaryInventoryView
Description	A complete view of the `Inventory` 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 inventories in warehouses which are children of this warehouse 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 lookups to this warehouse only.
Compliance	`mandatory`		This method is must be implemented.
Method	getInventory
Description	Gets the `Inventory` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Inventory` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Inventory` and retained for compatibility.
Parameters	`osid.id.Id`	`inventoryId`	`Id` of the `Inventory`
Return	`osid.inventory.Inventory`		the inventory
Errors	NOT_FOUND		`inventoryId` not found
	NULL_ARGUMENT		`inventoryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getInventoriesByIds
Description	Gets an `InventoryList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the inventories 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 `Inventories` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`inventoryIds`	the list of `Ids` to retrieve
Return	`osid.inventory.InventoryList`		the returned `Inventory` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`inventoryIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInventoriesByGenusType
Description	Gets an `InventoryList` corresponding to the given inventory genus `Type` which does not include inventories of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known inventories or an error results. Otherwise, the returned list may contain only those inventories that are accessible through this session.
Parameters	`osid.type.Type`	`inventoryGenusType`	an inventory genus type
Return	`osid.inventory.InventoryList`		the returned `Inventory` list
Errors	NULL_ARGUMENT		`inventoryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInventoriesByParentGenusType
Description	Gets an `InventoryList` corresponding to the given inventory genus `Type` and include any additional inventories with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known inventories or an error results. Otherwise, the returned list may contain only those inventories that are accessible through this session.
Parameters	`osid.type.Type`	`inventoryGenusType`	an inventory genus type
Return	`osid.inventory.InventoryList`		the returned `Inventory` list
Errors	NULL_ARGUMENT		`inventoryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInventoriesByRecordType
Description	Gets an `InventoryList` containing the given inventory record `Type.` In plenary mode, the returned list contains all known inventories or an error results. Otherwise, the returned list may contain only those inventories that are accessible through this session.
Parameters	`osid.type.Type`	`inventoryRecordType`	an inventory record type
Return	`osid.inventory.InventoryList`		the returned `Inventory` list
Errors	NULL_ARGUMENT		`inventoryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRecentInventories
Description	Gets the most recent `Inventories.` In plenary mode, the returned list contains all known inventories or an error results. Otherwise, the returned list may contain only those inventories that are accessible through this session.
Return	`osid.inventory.InventoryList`		the returned `Inventory` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInventoriesByDate
Description	Gets `Inventories` between the given date range inclusive `.` In plenary mode, the returned list contains all known inventories or an error results. Otherwise, the returned list may contain only those inventories that are accessible through this session.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.inventory.InventoryList`		the returned `Inventory` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	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	getInventoriesForStock
Description	Gets all `Inventories` for the given `Stock.` In plenary mode, the returned list contains all known inventories or an error results. Otherwise, the returned list may contain only those inventories that are accessible through this session.
Parameters	`osid.id.Id`	`stockId`	a stock `Id`
Return	`osid.inventory.InventoryList`		the returned `Inventory` list
Errors	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRecentInventoriesForStock
Description	Gets the most recent `Inventories` for with the given `Stock.` In plenary mode, the returned list contains all known inventories or an error results. Otherwise, the returned list may contain only those inventories that are accessible through this session.
Parameters	`osid.id.Id`	`stockId`	an inventory `Id`
Return	`osid.inventory.InventoryList`		the returned `Inventory` list
Errors	NULL_ARGUMENT		`stockId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInventoriesByDateForStock
Description	Gets `Inventories` between the given date range inclusive for the given stock `.` In plenary mode, the returned list contains all known inventories or an error results. Otherwise, the returned list may contain only those inventories that are accessible through this session.
Parameters	`osid.id.Id`	`stockId`	an inventory `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.inventory.InventoryList`		the returned `Inventory` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`stockid, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getInventories
Description	Gets all `Inventories.` In plenary mode, the returned list contains all known inventories or an error results. Otherwise, the returned list may contain only those inventories that are accessible through this session.
Return	`osid.inventory.InventoryList`		a list of `Inventories`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.