OSID Logo
OSID Specifications
inventory package
Version 3.1.0
Interfaceosid.inventory.WarehouseSearchResults
Implementsosid.OsidSearchResults
Used Byosid.inventory.WarehouseSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetWarehouses
Description

Gets the warehouse list resulting from a search.

Returnosid.inventory.WarehouseList the warehouse list
ErrorsILLEGAL_STATE the warehouse list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetWarehouseQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.inventory.WarehouseQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetWarehouseSearchResultsRecord
Description

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

Parametersosid.type.TypewarehouseSearchRecordType a warehouse search record type
Returnosid.inventory.records.WarehouseSearchResultsRecord the warehouse search results record
ErrorsNULL_ARGUMENT warehousesearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(warehouseSearchRecordType) is false
Compliancemandatory This method must be implemented.