Interface | osid.mapping.path.SpeedZoneQuery | ||
---|---|---|---|
Implements | osid.OsidRuleQuery | ||
Description |
This is the query for searching speed zones. Each method
match specifies an | ||
Method | matchPathId | ||
Description |
Sets the path | ||
Parameters | osid.id.Id | pathId | the path Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | pathId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearPathIdTerms | ||
Description |
Clears the path | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsPathQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a path query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPathQuery | ||
Description |
Gets the query for a path. Multiple retrievals produce
a nested | ||
Return | osid.mapping.path.PathQuery | the path query | |
Errors | UNIMPLEMENTED | supportsPathQuery() is false | |
Compliance | optional | This method must be implemented if supportsPathQuery() is
true. | |
Method | clearPathTerms | ||
Description |
Clears the path query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCoordinate | ||
Description |
Matches speed zones overlapping with the specified
| ||
Parameters | osid.mapping.Coordinate | coordinate | a coordinate |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | coordinate is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCoordinateTerms | ||
Description |
Clears the coordinate query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchContainingSpatialUnit | ||
Description |
Matches speed zones within the specified | ||
Parameters | osid.mapping.SpatialUnit | spatialUnit | a spatial unit |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | spatialUnit is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearContainingSpatialUnitTerms | ||
Description |
Clears the spatial unit terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchImplicit | ||
Description |
Matches implicitly defined speed zones. | ||
Parameters | boolean | match | true to match implicit speed zones with any boundary,
false otherwise |
Compliance | mandatory | This method must be implemented. | |
Method | clearImplicitTerms | ||
Description |
Clears the implicit query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchSpeedLimit | ||
Description |
Matches speed zones with speed limite within the given range inclusive. | ||
Parameters | osid.mapping.Speed | from | starting speed range |
osid.mapping.Speed | to | ending speed range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | from or to is null | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnySpeedLimit | ||
Description |
Matches speed zones with any speed limit set. | ||
Parameters | boolean | match | true to match implicit speed zones with any speed limit,
false otherwise |
Compliance | mandatory | This method must be implemented. | |
Method | clearSpeedLimitTerms | ||
Description |
Clears the speed limit query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMapId | ||
Description |
Sets the map | ||
Parameters | osid.id.Id | mapId | the map Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | mapId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMapIdTerms | ||
Description |
Clears the map | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsMapQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a map query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getMapQuery | ||
Description |
Gets the query for a map. Multiple retrievals produce a
nested | ||
Return | osid.mapping.MapQuery | the map query | |
Errors | UNIMPLEMENTED | supportsMapQuery() is false | |
Compliance | optional | This method must be implemented if supportsMapQuery() is
true. | |
Method | clearMapTerms | ||
Description |
Clears the map query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZoneQueryRecord | ||
Description |
Gets the speed zone query record corresponding to the
given | ||
Parameters | osid.type.Type | speedZoneRecordType | a speed zone record type |
Return | osid.mapping.path.records.SpeedZoneQueryRecord | the speed zone query record | |
Errors | NULL_ARGUMENT | speedZoneRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(speedZoneRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |