OSID Logo
OSID Specifications
mapping path rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.rules.SignalEnablerSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetSignalEnablers
Description

Gets the SignalEnablerList resulting from a search.

Returnosid.mapping.path.rules.SignalEnablerListthe signal enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetSignalEnablerQueryInspector
Description

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

Returnosid.mapping.path.rules.SignalEnablerQueryInspectorthe signal enabler query inspector
CompliancemandatoryThis method must be implemented.
MethodgetSignalEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypesignalEnablerSearchRecordTypea signal enabler search record type
Returnosid.mapping.path.rules.records.SignalEnablerSearchResultsRecordthe signal enabler search results record
ErrorsNULL_ARGUMENT signalEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(signalEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.