OSID - osid.inventory.ItemLookupSession Service Interface Definition

Interface	osid.inventory.ItemLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving items. An `Item` is a scheduled course listed in a warehouse. An `Item` is derived from a `Course` and maps to an offering time and registered students. 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 item methods in this session operate, retrieve and pertain to items defined explicitly in the current warehouse. Using an isolated view is useful for managing `Items` with the `ItemAdminSession.` federated warehouse view: All item lookup methods in this session operate, retrieve and pertain to all items defined in this warehouse and any other itemss 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. Items may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Item.`
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	canLookupItems
Description	Tests if this user can perform `Item` 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	useComparativeItemView
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	usePlenaryItemView
Description	A complete view of the `Item` 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 items 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	getItem
Description	Gets the `Item` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Item` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Item` and retained for compatibility.
Parameters	`osid.id.Id`	`itemId`	the `Id` of the `Item` to retrieve
Return	`osid.inventory.Item`		the returned `Item`
Errors	NOT_FOUND		no `Item` found with the given `Id`
	NULL_ARGUMENT		`itemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getItemsByIds
Description	Gets an `ItemList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the 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 `Items` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`itemIds`	the list of `Ids` to retrieve
Return	`osid.inventory.ItemList`		the returned `Item` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`itemIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getItemsByGenusType
Description	Gets an `ItemList` corresponding to the given item genus `Type` which does not include items of types derived from the specified `Type.` In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those items that are accessible through this session.
Parameters	`osid.type.Type`	`itemGenusType`	an item genus type
Return	`osid.inventory.ItemList`		the returned `Item` list
Errors	NULL_ARGUMENT		`itemGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getItemsByParentGenusType
Description	Gets an `ItemList` corresponding to the given item genus `Type` and include any additional items with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those items that are accessible through this session.
Parameters	`osid.type.Type`	`itemGenusType`	an item genus type
Return	`osid.inventory.ItemList`		the returned `Item` list
Errors	NULL_ARGUMENT		`itemGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getItemsByRecordType
Description	Gets an `ItemList` containing the given item record `Type.` In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those items that are accessible through this session.
Parameters	`osid.type.Type`	`itemRecordType`	an item record type
Return	`osid.inventory.ItemList`		the returned `Item` list
Errors	NULL_ARGUMENT		`itemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getItemsByStock
Description	Gets an `ItemList` for the given stock. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those items that are accessible through this session.
Parameters	`osid.id.Id`	`stockId`	a stock `Id`
Return	`osid.inventory.ItemList`		the returned `Item` 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	getItemsByPropertyTag
Description	Gets an `ItemList` for the given property tag. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those items that are accessible through this session.
Parameters	`string`	`property`	a property number
Return	`osid.inventory.ItemList`		the returned `Item` list
Errors	NULL_ARGUMENT		`property` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getItemsBySerialNumber
Description	Gets an `ItemList` for the given serial number. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those items that are accessible through this session.
Parameters	`string`	`serialNumber`	a serial number
Return	`osid.inventory.ItemList`		the returned `Item` list
Errors	NULL_ARGUMENT		`serialNumber` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getItemParts
Description	Gets an `ItemList` immediately contained within the given item. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those items that are accessible through this session.
Parameters	`osid.id.Id`	`itemId`	an item `Id`
Return	`osid.inventory.ItemList`		the returned `Item` list
Errors	NULL_ARGUMENT		`itemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getItems
Description	Gets all `Items.` In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those items that are accessible through this session.
Return	`osid.inventory.ItemList`		a list of `Items`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.