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

ParameterSearch specifies the interface for specifying parameter search options.

MethodsearchAmongParameters
Description

Executes this search among a given list of parameters.

Parametersosid.id.IdListparameterIdslist of parameters
ErrorsNULL_ARGUMENT parameterIds is null
CompliancemandatoryThis method must be implemented.
MethodorderParameterResults
Description

Specify an ordering to the search results.

Parametersosid.configuration.ParameterSearchOrderparameterSearchOrderparameter search order
ErrorsNULL_ARGUMENT parameterSearchOrder is null
UNSUPPORTED parameterSearchOrder is not of this service
CompliancemandatoryThis 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.TypeparameterSearchRecordTypea parameter search record type
Returnosid.configuration.records.ParameterSearchRecordthe parameter search record
ErrorsNULL_ARGUMENT parameterRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(parameterSearchRecordType) is false
CompliancemandatoryThis method must be implemented.