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

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

MethodgetModels
Description

Gets the model list resulting from a search.

Returnosid.inventory.ModelListthe model list
ErrorsILLEGAL_STATEthe model list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetModelQueryInspector
Description

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

Returnosid.inventory.ModelQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypemodelSearchRecordTypea model search record type
Returnosid.inventory.records.ModelSearchResultsRecordthe model search results record
ErrorsNULL_ARGUMENT modelSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(modelSearchRecordType) is false
CompliancemandatoryThis method must be implemented.