Interface | osid.mapping.path.rules.SpeedZoneEnablerSmartMapSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic map. 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 map. 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 | getSpeedZoneEnablerQuery | ||
Description |
Gets a speed zone enabler query. | ||
Return | osid.mapping.path.rules.SpeedZoneEnablerQuery | the speed zone enabler query | |
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZoneEnablerSearchOrder | ||
Description |
Gets a speed zone enabler search order. | ||
Return | osid.mapping.path.rules.SpeedZoneEnablerSearchOrder | the speed zone enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applySpeedZoneEnablerQuery | ||
Description |
Applies a speed zone enabler query to this map. | ||
Parameters | osid.mapping.path.rules.SpeedZoneEnablerQuery | speedZoneEnablerQuery | the speed zone enabler query |
Errors | NULL_ARGUMENT | speedZoneEnablerQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | speedZoneEnablerQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectSpeedZoneEnablerQuery | ||
Description |
Gets a speed zone enabler query inspector for this map. | ||
Return | osid.mapping.path.rules.SpeedZoneEnablerQueryInspector | the speed zone enabler query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applySpeedZoneEnablerSequencing | ||
Description |
Applies a speed zone enabler search order to this map. | ||
Parameters | osid.mapping.path.rules.SpeedZoneEnablerSearchOrder | speedZoneEnablerSearchOrder | the speed zone enabler search order |
Errors | NULL_ARGUMENT | speedZoneEnablerSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | speedZoneEnablerSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZoneEnablerQueryFromInspector | ||
Description |
Gets a speed zone enabler query from an inspector. | ||
Parameters | osid.mapping.path.rules.SpeedZoneEnablerQueryInspector | speedZoneEnablerQueryInspector | a speed zone enabler query inspector |
Return | osid.mapping.path.rules.SpeedZoneEnablerQuery | the speed zone enabler query | |
Errors | NULL_ARGUMENT | speedZoneEnablerQueryInspector is null | |
UNSUPPORTED | speedZoneEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |