OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ConfigurationSearch
Implementsosid.OsidSearch
Description

The search interface to query a configuration.

MethodsearchAmongConfigurations
Description

Execute this search among the given list of configurations.

Parametersosid.id.IdListconfigurationIdslist of configurations
ErrorsNULL_ARGUMENT configurationIds is null
CompliancemandatoryThis method must be implemented.
MethodorderConfigurationResults
Description

Specify an ordering to the search results.

Parametersosid.configuration.ConfigurationSearchOrderconfigurationSearchOrderconfiguration search order
ErrorsNULL_ARGUMENT configurationSearchOrder is null
UNSUPPORTED configurationSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationSearchRecord
Description

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

Parametersosid.type.TypeconfigurationSearchRecordTypea configuration search record type
Returnosid.configuration.records.ConfigurationSearchRecordthe configuration search record
ErrorsNULL_ARGUMENT configurationSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(configurationSearchRecordType) is false
CompliancemandatoryThis method must be implemented.