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

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

MethodgetStocks
Description

Gets the stock list resulting from a search.

Returnosid.inventory.StockListthe stock list
ErrorsILLEGAL_STATEthe stock list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetStockQueryInspector
Description

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

Returnosid.inventory.StockQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetStockSearchResultsRecord
Description

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

Parametersosid.type.TypestockSearchRecordTypea stock search record type
Returnosid.inventory.records.StockSearchResultsRecordthe stock search results record
ErrorsNULL_ARGUMENT stockSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(stockSearchRecordType) is false
CompliancemandatoryThis method must be implemented.