OSID Logo
OSID Specifications
mapping path rules package
Version 3.1.0
Interfaceosid.mapping.path.rules.SignalEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.mapping.path.rules.SignalEnablerSearchSession
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.SignalEnablerList the signal enabler list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetSignalEnablerQueryInspector
Description

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

Returnosid.mapping.path.rules.SignalEnablerQueryInspector the signal enabler query inspector
Compliancemandatory This 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.TypesignalEnablerSearchRecordType a signal enabler search record type
Returnosid.mapping.path.rules.records.SignalEnablerSearchResultsRecord the signal enabler search results record
ErrorsNULL_ARGUMENT signalEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(signalEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.