OSID Logo
OSID Specifications
inventory package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.WarehouseSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetWarehouses
Description

Gets the warehouse list resulting from a search.

Returnosid.inventory.WarehouseListthe warehouse list
ErrorsILLEGAL_STATEthe warehouse list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetWarehouseQueryInspector
Description

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

Returnosid.inventory.WarehouseQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypewarehouseSearchRecordTypea warehouse search record type
Returnosid.inventory.records.WarehouseSearchResultsRecordthe warehouse search results record
ErrorsNULL_ARGUMENT warehousesearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(warehouseSearchRecordType) is false
CompliancemandatoryThis method must be implemented.