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

The search interface for governing parameter processor searches.

MethodsearchAmongParameterProcessors
Description

Execute this search among the given list of parameter processors.

Parametersosid.id.IdListparameterProcessorIdslist of parameter processors
ErrorsNULL_ARGUMENT parameterProcessorIds is null
CompliancemandatoryThis method must be implemented.
MethodorderParameterProcessorResults
Description

Specify an ordering to the search results.

Parametersosid.configuration.rules.ParameterProcessorSearchOrderparameterProcessorSearchOrderparameter processor search order
ErrorsNULL_ARGUMENT parameterProcessorSearchOrder is null
UNSUPPORTED parameterProcessorSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorSearchRecord
Description

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

Parametersosid.type.TypeparameterProcessorSearchRecordTypea parameter processor search record type
Returnosid.configuration.rules.records.ParameterProcessorSearchRecordthe parameter processor search record
ErrorsNULL_ARGUMENT parameterProcessorSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(parameterProcessorSearchRecordType) is false
CompliancemandatoryThis method must be implemented.