OSID Logo
OSID Specifications
configuration package
Version 3.1.0
Interfaceosid.configuration.ParameterSearch
Implementsosid.OsidSearch
Used Byosid.configuration.ParameterSearchSession
Description

ParameterSearch specifies the interface for specifying parameter search options.

MethodsearchAmongParameters
Description

Executes this search among a given list of parameters.

Parametersosid.id.IdListparameterIds list of parameters
ErrorsNULL_ARGUMENT parameterIds is null
Compliancemandatory This method must be implemented.
MethodorderParameterResults
Description

Specify an ordering to the search results.

Parametersosid.configuration.ParameterSearchOrderparameterSearchOrder parameter search order
ErrorsNULL_ARGUMENT parameterSearchOrder is null
UNSUPPORTED parameterSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetParameterSearchRecord
Description

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

Parametersosid.type.TypeparameterSearchRecordType a parameter search record type
Returnosid.configuration.records.ParameterSearchRecord the parameter search record
ErrorsNULL_ARGUMENT parameterRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(parameterSearchRecordType) is false
Compliancemandatory This method must be implemented.