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

This session provides methods to retrieve Model to Warehouse mappings. A Model 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
MethodcanLookupModelWarehouseMappings
Description

Tests if this user can perform lookups of model/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.
MethoduseComparativeModelWarehouseView
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.
MethodusePlenaryModelWarehouseView
Description

A complete view of the Model 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.
MethodgetModelIdsByWarehouse
Description

Gets the list of Model Ids associated with a Warehouse.

Parametersosid.id.IdwarehouseId Id of the Warehouse
Returnosid.id.IdListlist of related model 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.
MethodgetModelsByWarehouse
Description

Gets the list of Models associated with a Warehouse.

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

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

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

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

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

Gets the Warehouse Ids mapped to a Model.

Parametersosid.id.IdmodelId Id of a Model
Returnosid.id.IdListlist of warehouses
ErrorsNOT_FOUND modelId is not found
NULL_ARGUMENT modelId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWarehousesByModel
Description

Gets the Warehouse objects mapped to a Model.

Parametersosid.id.IdmodelId Id of a Model
Returnosid.inventory.WarehouseListlist of warehouses
ErrorsNOT_FOUND modelId is not found
NULL_ARGUMENT modelId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.