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

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

MethodgetParameterProcessorEnablers
Description

Gets the ParameterProcessorEnablerList resulting from a search.

Returnosid.configuration.rules.ParameterProcessorEnablerListthe parameter processor enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorEnablerQueryInspector
Description

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

Returnosid.configuration.rules.ParameterProcessorEnablerQueryInspectorthe parameter processor enabler query inspector
CompliancemandatoryThis 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.TypeparameterProcessorEnablerSearchRecordTypea parameter processor enabler search record type
Returnosid.configuration.rules.records.ParameterProcessorEnablerSearchResultsRecordthe parameter processor enabler search results record
ErrorsNULL_ARGUMENT parameterProcessorEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(parameterProcessorEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.