Interface | osid.mapping.path.SpeedZoneMapSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupSpeedZoneMapSpeedZones | ||
Description |
Tests if this user can perform lookups of speed
zone/map speed zones. A return of true does not guarantee
successful authorization. A return of false indicates that
it is known lookup methods in this session will result in
a | ||
Return | boolean | false if looking up speed zones is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeSpeedZoneMapView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenarySpeedZoneMapView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSpeedZoneIdsByMap | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | mapId | Id of the Map |
Return | osid.id.IdList | list of related speed zone Ids | |
Errors | NOT_FOUND | mapId is not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZonesByMap | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | mapId | Id of the Map |
Return | osid.mapping.path.SpeedZoneList | list of related speed zones | |
Errors | NOT_FOUND | mapId is not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZoneIdsByMaps | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | mapIds | list of map Ids |
Return | osid.id.IdList | list of speed zone Ids | |
Errors | NULL_ARGUMENT | mapIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZonesByMaps | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | mapIds | list of map Ids |
Return | osid.mapping.path.SpeedZoneList | list of speed zones | |
Errors | NULL_ARGUMENT | mapIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMapIdsBySpeedZone | ||
Description |
Gets the | ||
Parameters | osid.id.Id | speedZoneId | Id of a SpeedZone |
Return | osid.id.IdList | list of maps | |
Errors | NOT_FOUND | speedZoneId is not found | |
NULL_ARGUMENT | speedZoneId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getMapsBySpeedZone | ||
Description |
Gets the | ||
Parameters | osid.id.Id | speedZoneId | Id of a SpeedZone |
Return | osid.mapping.MapList | list of maps | |
Errors | NOT_FOUND | speedZoneId is not found | |
NULL_ARGUMENT | speedZoneId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |