OSID Logo
OSID Specifications
lexicon package
Version 3.1.0
Interfaceosid.lexicon.ParameterSearchResults
Implementsosid.OsidSearchResults
Used Byosid.lexicon.ParameterSearchSession
Description

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

MethodgetParameters
Description

Gets the parameter list resulting from a search.

Returnosid.lexicon.ParameterList the parameter list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetParameterQueryInspector
Description

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

Returnosid.lexicon.ParameterQueryInspector the parameter query inspector
Compliancemandatory This method must be implemented.
MethodgetParameterSearchResultsRecord
Description

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

Parametersosid.type.TypeparameterSearchRecordType a parameter search record type
Returnosid.lexicon.records.ParameterSearchResultsRecord the parameter search results record
ErrorsNULL_ARGUMENT parameterSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(parameterSearchRecordType) is false
Compliancemandatory This method must be implemented.