OSID Logo
OSID Specifications
mapping path rules package
Version 3.1.0
Interfaceosid.mapping.path.rules.SignalEnablerQueryInspector
Implementsosid.OsidEnablerQueryInspector
Used Byosid.mapping.path.rules.SignalEnablerSearchResults
osid.mapping.path.rules.SignalEnablerSmartMapSession
Description

This is the query interface for examining signal enabler queries.

Like all OsidQueryInspectors, SignalEnablerQueryInspector is stateful and must not be accessed by multiple processing threads.

MethodgetRuledSignalIdTerms
Description

Gets the signal Id query terms.

Returnosid.search.terms.IdTerm[] the query terms
Compliancemandatory This method must be implemented.
MethodgetRuledSignalTerms
Description

Gets the signal query terms.

Returnosid.mapping.path.SignalQueryInspector[] the query terms
Compliancemandatory This method must be implemented.
MethodgetMapIdTerms
Description

Gets the map Id query terms.

Returnosid.search.terms.IdTerm[] the query terms
Compliancemandatory This method must be implemented.
MethodgetMapTerms
Description

Gets the map query terms.

Returnosid.mapping.MapQueryInspector[] the query terms
Compliancemandatory This method must be implemented.
MethodgetSignalEnablerQueryInspectorRecord
Description

Gets the signal enabler query inspector record corresponding to the given SignalEnabler record Type.

Parametersosid.type.TypesignalEnablerRecordType a signal enabler record type
Returnosid.mapping.path.rules.records.SignalEnablerQueryInspectorRecord the signal enabler query inspector record
ErrorsNULL_ARGUMENT signalEnablerRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(signalEnablerRecordType) is false
Compliancemandatory This method must be implemented.