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

This session provides methods for searching among Warehouse objects. The search query is constructed using the WarehouseQuery.

This session defines views that offer differing behaviors for searching.

  • federated warehouse view: searches include warehouses in warehouses of which this warehouse is an ancestor in the warehouse hierarchy
  • isolated warehouse view: searches are restricted to warehouses in this warehouse

warehouses may have a query record indicated by their respective record types. The query record is accessed via the WarehouseQuery.

MethodcanSearchWarehouses
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 not offer lookup operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetWarehouseQuery
Description

Gets a warehouse query.

Returnosid.inventory.WarehouseQuerythe warehouse query
CompliancemandatoryThis method must be implemented.
MethodgetWarehousesByQuery
Description

Gets a list of Warehouses matching the given warehouse query.

Parametersosid.inventory.WarehouseQuerywarehouseQuerythe warehouse query
Returnosid.inventory.WarehouseListthe returned WarehouseList
ErrorsNULL_ARGUMENT warehouseQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED warehouseQuery is not of this service
CompliancemandatoryThis method must be implemented.