OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.SettingSearch
Implementsosid.OsidSearch
Description

The search interface for governing setting searches.

MethodsearchAmongSettings
Description

Execute this search among the given list of settings.

Parametersosid.id.IdListsettingIdslist of settings
ErrorsNULL_ARGUMENT settingIds is null
CompliancemandatoryThis method must be implemented.
MethodorderSettingResults
Description

Specify an ordering to the search results.

Parametersosid.control.SettingSearchOrdersettingSearchOrdersetting search order
ErrorsNULL_ARGUMENT settingSearchOrder is null
UNSUPPORTED settingSearchOrder is not of this service
CompliancemandatoryThis 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.TypesettingSearchRecordTypea setting search record type
Returnosid.control.records.SettingSearchRecordthe setting search interface
ErrorsNULL_ARGUMENT settingSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(settingSearchRecordType) is false
CompliancemandatoryThis method must be implemented.