OSID Logo
OSID Specifications
configuration rules package
Version 3.1.0
Interfaceosid.configuration.rules.ParameterProcessorEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.configuration.rules.ParameterProcessorEnablerSearchSession
Description

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

MethodgetParameterProcessorEnablers
Description

Gets the ParameterProcessorEnablerList resulting from a search.

Returnosid.configuration.rules.ParameterProcessorEnablerList the parameter processor enabler list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetParameterProcessorEnablerQueryInspector
Description

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

Returnosid.configuration.rules.ParameterProcessorEnablerQueryInspector the parameter processor enabler query inspector
Compliancemandatory This method must be implemented.
MethodgetParameterProcessorEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypeparameterProcessorEnablerSearchRecordType a parameter processor enabler search record type
Returnosid.configuration.rules.records.ParameterProcessorEnablerSearchResultsRecord the parameter processor enabler search results record
ErrorsNULL_ARGUMENT parameterProcessorEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(parameterProcessorEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.