OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.SpeedZoneQuery
Implementsosid.OsidRuleQuery
Description

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

MethodmatchPathId
Description

Sets the path Id for this query to match speed zones along the given path.

Parametersosid.id.IdpathIdthe path Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT pathId is null
CompliancemandatoryThis method must be implemented.
MethodclearPathIdTerms
Description

Clears the path Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsPathQuery
Description

Tests if a PathQuery is available.

Returnboolean true if a path query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPathQuery
Description

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

Returnosid.mapping.path.PathQuerythe path query
ErrorsUNIMPLEMENTED supportsPathQuery() is false
ComplianceoptionalThis method must be implemented if supportsPathQuery() is true.
MethodclearPathTerms
Description

Clears the path query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCoordinate
Description

Matches speed zones overlapping with the specified Coordinate.

Parametersosid.mapping.Coordinatecoordinatea coordinate
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT coordinate is null
CompliancemandatoryThis method must be implemented.
MethodclearCoordinateTerms
Description

Clears the coordinate query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchContainingSpatialUnit
Description

Matches speed zones within the specified SpatialUnit.

Parametersosid.mapping.SpatialUnitspatialUnita spatial unit
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT spatialUnit is null
CompliancemandatoryThis method must be implemented.
MethodclearContainingSpatialUnitTerms
Description

Clears the spatial unit terms.

CompliancemandatoryThis method must be implemented.
MethodmatchImplicit
Description

Matches implicitly defined speed zones.

Parametersbooleanmatch true to match implicit speed zones with any boundary, false otherwise
CompliancemandatoryThis method must be implemented.
MethodclearImplicitTerms
Description

Clears the implicit query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchSpeedLimit
Description

Matches speed zones with speed limite within the given range inclusive.

Parametersosid.mapping.Speedfromstarting speed range
osid.mapping.Speedtoending speed range
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT from or to is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnySpeedLimit
Description

Matches speed zones with any speed limit set.

Parametersbooleanmatch true to match implicit speed zones with any speed limit, false otherwise
CompliancemandatoryThis method must be implemented.
MethodclearSpeedLimitTerms
Description

Clears the speed limit query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMapId
Description

Sets the map Id for this query.

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 a MapQuery is available.

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

Gets the query for a 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.
MethodgetSpeedZoneQueryRecord
Description

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

Parametersosid.type.TypespeedZoneRecordTypea speed zone record type
Returnosid.mapping.path.records.SpeedZoneQueryRecordthe speed zone query record
ErrorsNULL_ARGUMENT speedZoneRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(speedZoneRecordType) is false
CompliancemandatoryThis method must be implemented.