Interface | osid.mapping.path.SpeedZoneLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving speed zones. This lookup session defines several views:
The methods Speed zones may have an additional records indicated by
their respective record types. The record may not be accessed
through a cast of the | ||
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 | canLookupSpeedZones | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeSpeedZoneView | ||
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 | usePlenarySpeedZoneView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedMapView | ||
Description |
Federates the view for methods in this session. A federated view will include speed zones in maps which are children of this map in the map hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedMapView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this map only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveSpeedZoneView | ||
Description |
Only active speed zones are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusSpeedZoneView | ||
Description |
All active and inactive speed zones are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSpeedZone | ||
Description |
Gets the In active mode, speed zones are returned that are currently active. In any status mode, active and inactive speed zones are returned. | ||
Parameters | osid.id.Id | speedZoneId | the Id of the SpeedZone to retrieve |
Return | osid.mapping.path.SpeedZone | the returned SpeedZone | |
Errors | NOT_FOUND | no SpeedZone found with the given Id | |
NULL_ARGUMENT | speedZoneId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZonesByIds | ||
Description |
Gets a In active mode, speed zones are returned that are currently active. In any status mode, active and inactive speed zones are returned. | ||
Parameters | osid.id.IdList | speedZoneIds | the list of Ids to retrieve |
Return | osid.mapping.path.SpeedZoneList | the returned SpeedZone list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | speedZoneIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZonesByGenusType | ||
Description |
Gets a In active mode, speed zones are returned that are currently active. In any status mode, active and inactive speed zones are returned. | ||
Parameters | osid.type.Type | speedZoneGenusType | a speed zone genus type |
Return | osid.mapping.path.SpeedZoneList | the returned SpeedZone list | |
Errors | NULL_ARGUMENT | speedZoneGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZonesByParentGenusType | ||
Description |
Gets a In active mode, speed zones are returned that are currently active. In any status mode, active and inactive speed zones are returned. | ||
Parameters | osid.type.Type | speedZoneGenusType | a speed zone genus type |
Return | osid.mapping.path.SpeedZoneList | the returned SpeedZone list | |
Errors | NULL_ARGUMENT | speedZoneGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZonesByRecordType | ||
Description |
Gets a In plenary mode, the returned list contains all known speed zones or an error results. Otherwise, the returned list may contain only those speed zones that are accessible through this session. In active mode, speed zones are returned that are currently active. In any status mode, active and inactive speed zones are returned. | ||
Parameters | osid.type.Type | speedZoneRecordType | a speed zone record type |
Return | osid.mapping.path.SpeedZoneList | the returned SpeedZone list | |
Errors | NULL_ARGUMENT | speedZoneRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZonesForPath | ||
Description |
Gets a In plenary mode, the returned list contains all known spwed zones or an error results. Otherwise, the returned list may contain only those speed zones that are accessible through this session. In active mode, speed zones are returned that are currently active. In any status mode, active and inactive speed zones are returned. | ||
Parameters | osid.id.Id | pathId | a path Id |
Return | osid.mapping.path.SpeedZoneList | the returned SpeedZone list | |
Errors | NULL_ARGUMENT | pathId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZonesForPathAtCoordinate | ||
Description |
Gets a In plenary mode, the returned list contains all known speed zones or an error results. Otherwise, the returned list may contain only those speed zones that are accessible through this session. In active mode, speed zones are returned that are currently active. In any status mode, active and inactive speed zones are returned. | ||
Parameters | osid.id.Id | pathId | a path Id |
osid.mapping.Coordinate | coordinate | starting coordinate | |
osid.mapping.Distance | distance | a distance from coordinate | |
Return | osid.mapping.path.SpeedZoneList | the returned SpeedZone list | |
Errors | NULL_ARGUMENT | pathId, coordinate or distance is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedZones | ||
Description |
Gets all In plenary mode, the returned list contains all known speed zones or an error results. Otherwise, the returned list may contain only those speed zones that are accessible through this session. In active mode, speed zones are returned that are currently active. In any status mode, active and inactive speed zones are returned. | ||
Return | osid.mapping.path.SpeedZoneList | a list of SpeedZones | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |