Interface | osid.mapping.path.SpeedZoneSmartMapSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic catalogs. A This | ||
Method | getMapId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Map Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMap | ||
Description |
Gets the | ||
Return | osid.mapping.Map | the map | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageSmartMaps | ||
Description |
Tests if this user can manage smart maps. A return of
true does not guarantee successful authorization. A return
of false indicates that it is known methods in this
session will result in a | ||
Return | boolean | false if smart map management is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZoneQuery | ||
Description |
Gets a speed zone query. | ||
Return | osid.mapping.path.SpeedZoneQuery | the speed zone query | |
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZoneSearchOrder | ||
Description |
Gets a speed zone search order. | ||
Return | osid.mapping.path.SpeedZoneSearchOrder | the speed zone search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applySpeedZoneQuery | ||
Description |
Applies a speed zone query to this map. | ||
Parameters | osid.mapping.path.SpeedZoneQuery | speedZoneQuery | the speed zone query |
Errors | NULL_ARGUMENT | speedZoneQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | speedZoneQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspecSpeedZoneQuery | ||
Description |
Gets a speed zone query inspector for this map. | ||
Return | osid.mapping.path.SpeedZoneQueryInspector | the speed zone query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applySpeedZoneSequencing | ||
Description |
Applies a speed zone search order to this map. | ||
Parameters | osid.mapping.path.SpeedZoneSearchOrder | speedZoneSearchOrder | the speed zone search order |
Errors | NULL_ARGUMENT | speedZoneSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | speedZoneSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZoneQueryFromInspector | ||
Description |
Gets a speed zone query from an inspector. | ||
Parameters | osid.mapping.path.SpeedZoneQueryInspector | speedZoneQueryInspector | a speed zone query inspector |
Return | osid.mapping.path.SpeedZoneQuery | the speed zone query | |
Errors | NULL_ARGUMENT | speedZoneQueryInspector is null | |
UNSUPPORTED | speedZoneQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |