OSID Logo
OSID Specifications
configuration package
Version 3.1.0
Interfaceosid.configuration.ValueSearchResults
Implementsosid.OsidSearchResults
Used Byosid.configuration.ValueSearchSession
Description

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

MethodgetValues
Description

Gets the vakue list resulting from a search.

Returnosid.configuration.ValueList the value list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetValueQueryInspector
Description

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

Returnosid.configuration.ValueQueryInspector the value query inspector
Compliancemandatory This method must be implemented.
MethodgetValueSearchResultsRecord
Description

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

Parametersosid.type.TypevalueSearchRecordType a value search record type
Returnosid.configuration.records.ValueSearchResultsRecord the value search results record
ErrorsNULL_ARGUMENT valueSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(valueSearchRecordType) is false
Compliancemandatory This method must be implemented.