OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.ItemLookupSession
Implementsosid.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.

MethodgetWarehouseId
Description

Gets the Warehouse Id associated with this session.

Returnosid.id.Idthe Warehouse Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetWarehouse
Description

Gets the Warehouse associated with this session.

Returnosid.inventory.Warehousethe warehouse
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupItems
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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeItemView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryItemView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedWarehouseView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedWarehouseView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this warehouse only.

CompliancemandatoryThis method is must be implemented.
MethodgetItem
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.

Parametersosid.id.IditemIdthe Id of the Item to retrieve
Returnosid.inventory.Itemthe returned Item
ErrorsNOT_FOUNDno Item found with the given Id
NULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetItemsByIds
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.

Parametersosid.id.IdListitemIdsthe list of Ids to retrieve
Returnosid.inventory.ItemListthe returned Item list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT itemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetItemsByGenusType
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.

Parametersosid.type.TypeitemGenusTypean item genus type
Returnosid.inventory.ItemListthe returned Item list
ErrorsNULL_ARGUMENT itemGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetItemsByParentGenusType
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.

Parametersosid.type.TypeitemGenusTypean item genus type
Returnosid.inventory.ItemListthe returned Item list
ErrorsNULL_ARGUMENT itemGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetItemsByRecordType
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.

Parametersosid.type.TypeitemRecordTypean item record type
Returnosid.inventory.ItemListthe returned Item list
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetItemsByStock
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.

Parametersosid.id.IdstockIda stock Id
Returnosid.inventory.ItemListthe returned Item list
ErrorsNULL_ARGUMENT stockId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetItemsByPropertyTag
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.

Parametersstringpropertya property number
Returnosid.inventory.ItemListthe returned Item list
ErrorsNULL_ARGUMENT property is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetItemsBySerialNumber
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.

ParametersstringserialNumbera serial number
Returnosid.inventory.ItemListthe returned Item list
ErrorsNULL_ARGUMENT serialNumber is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetItemParts
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.

Parametersosid.id.IditemIdan item Id
Returnosid.inventory.ItemListthe returned Item list
ErrorsNULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetItems
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.

Returnosid.inventory.ItemLista list of Items
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.