OSID Logo
OSID Specifications
configuration rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.rules.ParameterProcessorSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetParameterProcessors
Description

Gets the ParameterProcessorList resulting from a search.

Returnosid.configuration.rules.ParameterProcessorListthe parameter processor list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.configuration.rules.ParameterProcessorQueryInspectorthe parameter processor query inspector
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorSearchResultsRecord
Description

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

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