OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.InputEnablerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetInputEnablers
Description

Gets the InputEnablerList resulting from a search.

Returnosid.control.rules.InputEnablerListthe input enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetInputEnablerQueryInspector
Description

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

Returnosid.control.rules.InputEnablerQueryInspectorthe input enabler query inspector
CompliancemandatoryThis 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.TypeinputEnablerSearchRecordTypean input enabler search record type
Returnosid.control.rules.records.InputEnablerSearchResultsRecordthe input enabler search results record
ErrorsNULL_ARGUMENT inputEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(inputEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.