OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.SpeedZoneMapSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve SpeedZone to Map speed zones. A SpeedZone may appear in multiple Map objects. Each map may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupSpeedZoneMapSpeedZones
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 PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up speed zones is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeSpeedZoneMapView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenarySpeedZoneMapView
Description

A complete view of the SpeedZone and Map returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetSpeedZoneIdsByMap
Description

Gets the list of SpeedZone Ids associated with a Map.

Parametersosid.id.IdmapId Id of the Map
Returnosid.id.IdListlist of related speed zone Ids
ErrorsNOT_FOUND mapId is not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZonesByMap
Description

Gets the list of SpeedZones associated with a Map.

Parametersosid.id.IdmapId Id of the Map
Returnosid.mapping.path.SpeedZoneListlist of related speed zones
ErrorsNOT_FOUND mapId is not found
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneIdsByMaps
Description

Gets the list of SpeedZone Ids corresponding to a list of Maps.

Parametersosid.id.IdListmapIdslist of map Ids
Returnosid.id.IdListlist of speed zone Ids
ErrorsNULL_ARGUMENT mapIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZonesByMaps
Description

Gets the list of SpeedZones corresponding to a list of Maps.

Parametersosid.id.IdListmapIdslist of map Ids
Returnosid.mapping.path.SpeedZoneListlist of speed zones
ErrorsNULL_ARGUMENT mapIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapIdsBySpeedZone
Description

Gets the Map Ids mapped to a SpeedZone.

Parametersosid.id.IdspeedZoneId Id of a SpeedZone
Returnosid.id.IdListlist of maps
ErrorsNOT_FOUND speedZoneId is not found
NULL_ARGUMENT speedZoneId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMapsBySpeedZone
Description

Gets the Maps mapped to a SpeedZone.

Parametersosid.id.IdspeedZoneId Id of a SpeedZone
Returnosid.mapping.MapListlist of maps
ErrorsNOT_FOUND speedZoneId is not found
NULL_ARGUMENT speedZoneId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.