Interface | osid.mapping.path.rules.SpeedZoneEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching speed zone enablers. Each
method match specifies a | ||
Method | matchRuledSpeedZoneId | ||
Description |
Matches enablers mapped to the speed zone. | ||
Parameters | osid.id.Id | speedZoneId | the speed zone Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | speedZoneId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledSpeedZoneIdTerms | ||
Description |
Clears the speed zone | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledSpeedZoneQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a speed zone query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledSpeedZoneQuery | ||
Description |
Gets the query for a speed zone. Multiple retrievals
produce a nested | ||
Return | osid.mapping.path.SpeedZoneQuery | the speed zone query | |
Errors | UNIMPLEMENTED | supportsRuledSpeedZoneQuery() is false | |
Compliance | optional | This method must be implemented if supportsRuledSpeedZoneQuery()
is true. | |
Method | matchAnyRuledSpeedZone | ||
Description |
Matches enablers mapped to any speed zone. | ||
Parameters | boolean | match | true for enablers mapped to any speed zone, false
to match enablers mapped to no speed zones |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledSpeedZoneTerms | ||
Description |
Clears the speed zone query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMapId | ||
Description |
Matches enablers mapped to 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 an | ||
Return | boolean | true if an map query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getMapQuery | ||
Description |
Gets the query for an 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 | getSpeedZoneEnablerQueryRecord | ||
Description |
Gets the speed zone enabler query record corresponding
to the given | ||
Parameters | osid.type.Type | speedZoneEnablerRecordType | a speed zone enabler record type |
Return | osid.mapping.path.rules.records.SpeedZoneEnablerQueryRecord | the speed zone enabler query record | |
Errors | NULL_ARGUMENT | speedZoneEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(speedZoneEnablerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |