OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.SettingSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetSettings
Description

Gets the setting list resulting from a search.

Returnosid.control.SettingListthe setting list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetSettingQueryInspector
Description

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

Returnosid.control.SettingQueryInspectorthe setting query inspector
CompliancemandatoryThis 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.TypesettingSearchRecordTypea setting search record type
Returnosid.control.records.SettingSearchResultsRecordthe setting search results record
ErrorsNULL_ARGUMENT settingSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(settingSearchRecordType) is false
CompliancemandatoryThis method must be implemented.