OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.SettingSearch
Implementsosid.OsidSearch
Used Byosid.control.SettingSearchSession
Description

The search interface for governing setting searches.

MethodsearchAmongSettings
Description

Execute this search among the given list of settings.

Parametersosid.id.IdListsettingIds list of settings
ErrorsNULL_ARGUMENT settingIds is null
Compliancemandatory This method must be implemented.
MethodorderSettingResults
Description

Specify an ordering to the search results.

Parametersosid.control.SettingSearchOrdersettingSearchOrder setting search order
ErrorsNULL_ARGUMENT settingSearchOrder is null
UNSUPPORTED settingSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetSettingSearchRecord
Description

Gets the setting search 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.SettingSearchRecord the setting search interface
ErrorsNULL_ARGUMENT settingSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(settingSearchRecordType) is false
Compliancemandatory This method must be implemented.