OSID Logo
OSID Specifications
lexicon package
Version 3.0.0
Interfaceosid.lexicon.ParameterSearch
Implementsosid.OsidSearch
Used Byosid.lexicon.ParameterSearchSession
Description

The search interface for governing parameter searches.

MethodsearchAmongParameters
Description

Execute this search among the given list of parameters.

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

Specify an ordering to the search results.

Parametersosid.lexicon.ParameterSearchOrderparameterSearchOrderparameter search order
ErrorsNULL_ARGUMENTparameterSearchOrder is null
UNSUPPORTEDparameterSearchOrder 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.lexicon.records.ParameterSearchRecordthe parameter search record
ErrorsNULL_ARGUMENTparameterSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(parameterSearchRecordType) is false
CompliancemandatoryThis method must be implemented.