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

This is the query for searching speed zone enablers. Each method match specifies a AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRuledSpeedZoneId
Description

Matches enablers mapped to the speed zone.

Parametersosid.id.IdspeedZoneIdthe speed zone Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT speedZoneId is null
CompliancemandatoryThis method must be implemented.
MethodclearRuledSpeedZoneIdTerms
Description

Clears the speed zone Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRuledSpeedZoneQuery
Description

Tests if a SpeedZoneQuery is available.

Returnboolean true if a speed zone query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuledSpeedZoneQuery
Description

Gets the query for a speed zone. Multiple retrievals produce a nested OR term.

Returnosid.mapping.path.SpeedZoneQuerythe speed zone query
ErrorsUNIMPLEMENTED supportsRuledSpeedZoneQuery() is false
ComplianceoptionalThis method must be implemented if supportsRuledSpeedZoneQuery() is true.
MethodmatchAnyRuledSpeedZone
Description

Matches enablers mapped to any speed zone.

Parametersbooleanmatch true for enablers mapped to any speed zone, false to match enablers mapped to no speed zones
CompliancemandatoryThis method must be implemented.
MethodclearRuledSpeedZoneTerms
Description

Clears the speed zone query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMapId
Description

Matches enablers mapped to the map.

Parametersosid.id.IdmapIdthe map Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT mapId is null
CompliancemandatoryThis method must be implemented.
MethodclearMapIdTerms
Description

Clears the map Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsMapQuery
Description

Tests if an MapQuery is available.

Returnboolean true if an map query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetMapQuery
Description

Gets the query for an map. Multiple retrievals produce a nested OR term.

Returnosid.mapping.MapQuerythe map query
ErrorsUNIMPLEMENTED supportsMapQuery() is false
ComplianceoptionalThis method must be implemented if supportsMapQuery() is true.
MethodclearMapTerms
Description

Clears the map query terms.

CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneEnablerQueryRecord
Description

Gets the speed zone enabler query record corresponding to the given SpeedZoneEnabler record Type. Multiple record retrievals produce a nested OR term.

Parametersosid.type.TypespeedZoneEnablerRecordTypea speed zone enabler record type
Returnosid.mapping.path.rules.records.SpeedZoneEnablerQueryRecordthe speed zone enabler query record
ErrorsNULL_ARGUMENT speedZoneEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(speedZoneEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.