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

This is the query interface for examining signal enabler queries.

MethodgetRuledSignalIdTerms
Description

Gets the signal Id query terms.

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

Gets the signal query terms.

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

Gets the map Id query terms.

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

Gets the map query terms.

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

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

Parametersosid.type.TypesignalEnablerRecordTypea signal enabler record type
Returnosid.mapping.path.rules.records.SignalEnablerQueryInspectorRecordthe signal enabler query inspector record
ErrorsNULL_ARGUMENT signalEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(signalEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.