OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.WarehouseSearch
Implementsosid.OsidSearch
Description

The search interface for governing warehouse searches.

MethodsearchAmongWarehouses
Description

Execute this search among the given list of warehouses.

Parametersosid.id.IdListwarehouseIdslist of warehouses
ErrorsNULL_ARGUMENT warehouseIds is null
CompliancemandatoryThis method must be implemented.
MethodorderWarehouseResults
Description

Specify an ordering to the search results.

Parametersosid.inventory.WarehouseSearchOrderwarehouseSearchOrderwarehouse search order
ErrorsNULL_ARGUMENT warehousesearchOrder is null
UNSUPPORTED warehousesearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetWarehouseSearchRecord
Description

Gets the warehouse search record corresponding to the given warehouse search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypewarehouSesearchRecordTypea warehouse search record type
Returnosid.inventory.records.WarehouseSearchRecordthe warehouse search record
ErrorsNULL_ARGUMENT warehouseSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(warehouseSearchRecordType) is false
CompliancemandatoryThis method must be implemented.