OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.SettingSearchResults
Implementsosid.OsidSearchResults
Used Byosid.control.SettingSearchSession
Description

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

MethodgetSettings
Description

Gets the setting list resulting from a search.

Returnosid.control.SettingList the setting list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetSettingQueryInspector
Description

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

Returnosid.control.SettingQueryInspector the setting query inspector
Compliancemandatory This method must be implemented.
MethodgetSettingSearchResultsRecord
Description

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

Parametersosid.type.TypesettingSearchRecordType a setting search record type
Returnosid.control.records.SettingSearchResultsRecord the setting search results record
ErrorsNULL_ARGUMENT settingSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(settingSearchRecordType) is false
Compliancemandatory This method must be implemented.