OSID Logo
OSID Specifications
inventory package
Version 3.1.0
Interfaceosid.inventory.ModelSearchResults
Implementsosid.OsidSearchResults
Used Byosid.inventory.ModelSearchSession
Description

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

MethodgetModels
Description

Gets the model list resulting from a search.

Returnosid.inventory.ModelList the model list
ErrorsILLEGAL_STATE the model list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetModelQueryInspector
Description

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

Returnosid.inventory.ModelQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetModelSearchResultsRecord
Description

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

Parametersosid.type.TypemodelSearchRecordType a model search record type
Returnosid.inventory.records.ModelSearchResultsRecord the model search results record
ErrorsNULL_ARGUMENT modelSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(modelSearchRecordType) is false
Compliancemandatory This method must be implemented.