OSID Logo
OSID Specifications
control rules package
Version 3.1.0
Interfaceosid.control.rules.InputEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.control.rules.InputEnablerSearchSession
Description

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

MethodgetInputEnablers
Description

Gets the InputEnablerList resulting from a search.

Returnosid.control.rules.InputEnablerList the input enabler list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetInputEnablerQueryInspector
Description

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

Returnosid.control.rules.InputEnablerQueryInspector the input enabler query inspector
Compliancemandatory This method must be implemented.
MethodgetInputEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypeinputEnablerSearchRecordType an input enabler search record type
Returnosid.control.rules.records.InputEnablerSearchResultsRecord the input enabler search results record
ErrorsNULL_ARGUMENT inputEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(inputEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.