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

This session provides methods for retrieving Warehouse objects.

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Warehouses it can access, without breaking execution. However, an assessment may only be useful if all Warehouses referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

MethodcanLookupWarehouses
Description

Tests if this user can perform Warehouse 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.

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

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

Gets the Warehouse specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Warehouse may have a different Id than requested, such as the case where a duplicate Id was assigned to a Warehouse and retained for compatibility.

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

Gets a WarehouseList corresponding to the given IdList. In plenary mode, the returned list contains all of the warehouses 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 Warehouses may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListwarehouseIdsthe list of Ids to retrieve
Returnosid.inventory.WarehouseListthe returned Warehouse list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT warehouseIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWarehousesByGenusType
Description

Gets a WarehouseList corresponding to the given warehouse genus Type which does not include warehouses of types derived from the specified Type. In plenary mode, the returned list contains all known warehouses or an error results. Otherwise, the returned list may contain only those warehouses that are accessible through this session.

Parametersosid.type.TypewarehouseGenusTypea warehouse genus type
Returnosid.inventory.WarehouseListthe returned Warehouse list
ErrorsNULL_ARGUMENT warehouseGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWarehousesByParentGenusType
Description

Gets a WarehouseList corresponding to the given warehouse genus Type and include any additional warehouses with genus types derived from the specified Type. In plenary mode, the returned list contains all known warehouses or an error results. Otherwise, the returned list may contain only those warehouses that are accessible through this session.

Parametersosid.type.TypewarehouseGenusTypea warehouse genus type
Returnosid.inventory.WarehouseListthe returned Warehouse list
ErrorsNULL_ARGUMENT warehouseGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWarehousesByRecordType
Description

Gets a WarehouseList containing the given warehouse record Type. In plenary mode, the returned list contains all known warehouses or an error results. Otherwise, the returned list may contain only those warehouses that are accessible through this session.

Parametersosid.type.TypewarehouseRecordTypea warehouse record type
Returnosid.inventory.WarehouseListthe returned Warehouse list
ErrorsNULL_ARGUMENT warehouseRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWarehousesByProvider
Description

Gets a WarehouseList for the given provider. In plenary mode, the returned list contains all known warehouses or an error results. Otherwise, the returned list may contain only those warehouses that are accessible through this session.

Parametersosid.id.IdresourceIda resource Id
Returnosid.inventory.WarehouseListthe returned Warehouse list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWarehouses
Description

Gets all Warehouses. In plenary mode, the returned list contains all known warehouses or an error results. Otherwise, the returned list may contain only those warehouses that are accessible through this session.

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