OSID Logo
OSID Specifications
configuration package
Version 3.1.0
Interfaceosid.configuration.ConfigurationSearch
Implementsosid.OsidSearch
Used Byosid.configuration.ConfigurationSearchSession
Description

The search interface to query a configuration.

MethodsearchAmongConfigurations
Description

Execute this search among the given list of configurations.

Parametersosid.id.IdListconfigurationIds list of configurations
ErrorsNULL_ARGUMENT configurationIds is null
Compliancemandatory This method must be implemented.
MethodorderConfigurationResults
Description

Specify an ordering to the search results.

Parametersosid.configuration.ConfigurationSearchOrderconfigurationSearchOrder configuration search order
ErrorsNULL_ARGUMENT configurationSearchOrder is null
UNSUPPORTED configurationSearchOrder is not of this service
Compliancemandatory This 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.TypeconfigurationSearchRecordType a configuration search record type
Returnosid.configuration.records.ConfigurationSearchRecord the configuration search record
ErrorsNULL_ARGUMENT configurationSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(configurationSearchRecordType) is false
Compliancemandatory This method must be implemented.