OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.ItemWarehouseSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Item to Warehouse mappings. An Item may appear in multiple Warehouse objects. Each catalog may have its own authorizations governing who is allowed to look at it.

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
MethodcanLookupItemWarehouseMappings
Description

Tests if this user can perform lookups of item/warehouse mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeItemWarehouseView
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.
MethodusePlenaryItemCatalogView
Description

A complete view of the Item and Warehouse 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.
MethodgetItemIdsByWarehouse
Description

Gets the list of Item Ids associated with a Warehouse.

Parametersosid.id.IdwarehouseId Id of the Warehouse
Returnosid.id.IdListlist of related item Ids
ErrorsNOT_FOUND warehouseId is not found
NULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetItemsByWarehouse
Description

Gets the list of Items associated with a Warehouse.

Parametersosid.id.IdwarehouseId Id of the Warehouse
Returnosid.inventory.ItemListlist of related items
ErrorsNOT_FOUND warehouseId is not found
NULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetItemIdsByWarehouses
Description

Gets the list of Item Ids corresponding to a list of Warehouse objects.

Parametersosid.id.IdListwarehouseIdslist of warehouse Ids
Returnosid.id.IdListlist of item Ids
ErrorsNULL_ARGUMENT warehouseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetItemsByWarehouses
Description

Gets the list of Items corresponding to a list of Warehouse objects.

Parametersosid.id.IdListwarehouseIdslist of warehouse Ids
Returnosid.inventory.ItemListlist of items
ErrorsNULL_ARGUMENT warehouseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWarehouseIdsByItem
Description

Gets the Warehouse Ids mapped to an Item.

Parametersosid.id.IditemId Id of an Item
Returnosid.id.IdListlist of warehouses
ErrorsNOT_FOUND itemId is not found
NULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWarehousesByItem
Description

Gets the Warehouse objects mapped to an Item.

Parametersosid.id.IditemId Id of an Item
Returnosid.inventory.WarehouseListlist of warehouses
ErrorsNOT_FOUND itemId is not found
NULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.