OSID Logo
OSID Specifications
mapping path package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.MappingPathManager
Implementsosid.OsidManager
osid.mapping.path.MappingPathProfile
Description

The mapping path manager provides access to path sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • PathLookupSession: a session to retrieve paths
  • PathQuerySession: a session to query for paths
  • PathSearchSession: a session to search for paths
  • PathAdminSession: a session to create and delete paths
  • PathNotificationSession: a session to receive notifications pertaining to path changes
  • PathMapSession: a session to looking up mappings of paths to maps
  • PathMapAssignmentSession: a session to manage path to map mappings
  • PathMapAssignmentSession: a session to manage dynamic maps of paths
  • PathSpatialSession: a session to query paths spatially
  • PathSpatialDesignSession: a session to spatially design paths
  • PathTravelSession: a session to examining a path for travel
  • ResourcePathNotificationSession: a session to subscirbe to resources moving across paths
  • ResourceVelocitySession: a session to examine resource velocities
  • ResourceVelocityUpdateSession: a session to update resource velocities
  • ResourceVelocityNotificationSession: a session to subscribe to changes in resource velocities
  • MyPathSession: a session to examine paths and velocities for the authenticated agent.
  • IntersectionLookupSession: a session to retrieve intersections
  • IntersectionQuerySession: a session to query for intersections
  • IntersectionSearchSession: a session to search for intersections
  • IntersectionAdminSession: a session to create and delete intersections
  • IntersectionNotificationSession: a session to receive notifications pertaining to intersection changes
  • IntersectionMapSession: a session to looking up mappings of intersections to maps
  • IntersectionMapAssignmentSession: a session to manage intersection to map mappings
  • IntersectionMapAssignmentSession: a session to manage dynamic maps of intersections
  • SpeedZoneLookupSession: a session to retrieve speed zones
  • SpeedZoneQuerySession: a session to query for speed zones
  • SpeedZoneSearchSession: a session to search for speed zones
  • SpeedZoneAdminSession: a session to create and delete speed zones
  • SpeedZoneNotificationSession: a session to receive notifications pertaining to speed zone changes
  • SpeedZoneMapSession: a session to look up speed zone to map mappings
  • SpeedZoneMapAssignmentSession: a session to manage speed zone to map mappings
  • SpeedZoneSmartMapSession: a session to manage dynamic maps of speed zones
  • SignalLookupSession: a session to retrieve signals
  • SignalQuerySession: a session to query for signals
  • SignalSearchSession: a session to search for signals
  • SignalAdminSession: a session to create and delete signals
  • SignalNotificationSession: a session to receive notifications pertaining to signal changes
  • SignalMapSession: a session to look up signal to map mappings
  • SignalMapAssignmentSession: a session to manage signal to map mappings
  • SignalSmartMapSession: a session to manage dynamic maps of signals
  • ResourceSignalNotificationSession: a session to subscribe to signal crossing events
  • ObstacleLookupSession: a session to retrieve obstacles
  • ObstacleQuerySession: a session to query for obstacles
  • ObstacleSearchSession: a session to search for obstacles
  • ObstacleAdminSession: a session to create and delete obstacles
  • ObstacleNotificationSession: a session to receive notifications pertaining to obstacles changes
  • ObstacleHierarchySession: a session to examine obstacles in a hierarchy
  • ObstacleHierarchyAssignmentSession: a session to traverse the obstacle hierarchy
  • ObstacleMapSession: a session to look up obstacle to map mappings
  • ObstacleMapAssignmentSession: a session to manage obstacle to map mappings
  • ObstacleSmartMapSession: a session to manage dynamic maps of obstacles
MethodgetPathLookupSession
Description

Gets the OsidSession associated with the path lookup service.

Returnosid.mapping.path.PathLookupSessiona PathLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathLookup() is false
ComplianceoptionalThis method must be implemented if supportsPathLookup() is true.
MethodgetPathLookupSessionForMap
Description

Gets the OsidSession associated with the path lookup service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.PathLookupSessiona PathLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPathLookup() and supportsVisibleFederation() are true
MethodgetPathQuerySession
Description

Gets the OsidSession associated with the path query service.

Returnosid.mapping.path.PathQuerySessiona PathQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathQuery() is false
ComplianceoptionalThis method must be implemented if supportsPathQuery() is true.
MethodgetPathQuerySessionForMap
Description

Gets the OsidSession associated with the path query service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.PathQuerySessiona PathQuerySession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPathQuery() and supportsVisibleFederation() are true
MethodgetPathSearchSession
Description

Gets the OsidSession associated with the path search service.

Returnosid.mapping.path.PathSearchSessiona PathSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathSearch() is false
ComplianceoptionalThis method must be implemented if supportsPathSearch() is true.
MethodgetPathSearchSessionForMap
Description

Gets the OsidSession associated with the path search service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.PathSearchSessiona PathSearchSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPathSearch() and supportsVisibleFederation() are true
MethodgetPathAdminSession
Description

Gets the OsidSession associated with the path administration service.

Returnosid.mapping.path.PathAdminSessiona PathAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathAdmin() is false
ComplianceoptionalThis method must be implemented if supportsPathAdmin() is true.
MethodgetPathAdminSessionForMap
Description

Gets the OsidSession associated with the path administration service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.PathAdminSessiona PathAdminSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPathAdmin() and supportsVisibleFederation() are true
MethodgetPathNotificationSession
Description

Gets the OsidSession associated with the path notification service.

Parametersosid.mapping.path.PathReceiverpathReceiverthe notification callback
Returnosid.mapping.path.PathNotificationSessiona PathNotificationSession
ErrorsNULL_ARGUMENT pathReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathNotification() is false
ComplianceoptionalThis method must be implemented if supportsPathNotification() is true.
MethodgetPathNotificationSessionForMap
Description

Gets the OsidSession associated with the path notification service for the given map.

Parametersosid.mapping.path.PathReceiverpathReceiverthe notification callback
osid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.PathNotificationSessiona PathNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT pathReceiver or mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPathNotification() and supportsVisibleFederation() are true
MethodgetPathMapSession
Description

Gets the OsidSession to lookup path/map mappings.

Returnosid.mapping.path.PathMapSessiona PathMapSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathMap() is false
ComplianceoptionalThis method must be implemented if supportsPathMap() is true.
MethodgetPathMapAssignmentSession
Description

Gets the OsidSession associated with assigning paths to maps.

Returnosid.mapping.path.PathMapAssignmentSessiona PathMapAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathMapAssignment() is false
ComplianceoptionalThis method must be implemented if supportsPathMapAssignment() is true.
MethodgetPathSmartMapSession
Description

Gets the OsidSession to manage path smart maps.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.PathSmartMapSessiona PathSmartMapSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathSmartMap() is false
ComplianceoptionalThis method must be implemented if supportsPathSmartMap() is true.
MethodgetPathSpatialSession
Description

Gets the OsidSession associated with the path spatial service.

Returnosid.mapping.path.PathSpatialSessiona PathSpatialSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathSpatial() is false
ComplianceoptionalThis method must be implemented if supportsPathSpatial() is true.
MethodgetPathSpatialSessionForMap
Description

Gets the OsidSession associated with the path spatial service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.PathSpatialSessiona PathSpatialSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathSpatial() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPathSpatial() and supportsVisibleFederation() are true
MethodgetPathSpatialDesignSession
Description

Gets the OsidSession associated with the path spatial design service.

Returnosid.mapping.path.PathSpatialDesignSessiona PathSpatialDesignSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathSpatialDesign() is false
ComplianceoptionalThis method must be implemented if supportsPathSpatialDesign() is true.
MethodgetPathSpatialDesignSessionForMap
Description

Gets the OsidSession associated with the path spatial design service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.PathSpatialDesignSessiona PathSpatialDesignSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathSpatialDesign() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPathSpatialDesign() and supportsVisibleFederation() are true
MethodgetPathTravelSession
Description

Gets the OsidSession associated with the path travel service.

Returnosid.mapping.path.PathTravelSessiona PathTravelSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathTravel() is false
ComplianceoptionalThis method must be implemented if supportsPathTravel() is true.
MethodgetPathTravelSessionForMap
Description

Gets the OsidSession associated with the path travel service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.PathTravelSessiona PathTravelSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsPathTravel() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsPathTravel() and supportsVisibleFederation() are true
MethodgetResourcePathNotificationSession
Description

Gets the OsidSession associated with the resource path notification service.

Parametersosid.mapping.path.ResourcePathReceiverresourcePathReceiverthe notification callback
Returnosid.mapping.path.ResourcePathNotificationSessiona ResourcePathNotificationSession
ErrorsNULL_ARGUMENT resourcePathReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourcePathNotification() is false
ComplianceoptionalThis method must be implemented if supportsResourcePathNotification() is true.
MethodgetResourcePathNotificationSessionForMap
Description

Gets the OsidSession associated with the resource path notification service for the given map.

Parametersosid.mapping.path.ResourcePathReceiverresourcePathReceiverthe notification callback
osid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.ResourcePathNotificationSessiona ResourcePathNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT resourcePathReceiver or mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourcePathNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResourcePathNotification() and supportsVisibleFederation() are true
MethodgetResourceVelocitySession
Description

Gets the OsidSession associated with the resource velocity service.

Returnosid.mapping.path.ResourceVelocitySessiona ResourceVelocitySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceVelocity() is false
ComplianceoptionalThis method must be implemented if supportsResourceVelocity() is true.
MethodgetResourceVelocitySessionForMap
Description

Gets the OsidSession associated with the resource velocity service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.ResourceVelocitySessiona ResourceVelocitySession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceVelocity() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResourceVelocity() and supportsVisibleFederation() are true
MethodgetResourceVelocityUpdateSession
Description

Gets the OsidSession associated with the resource velocity update service.

Returnosid.mapping.path.ResourceVelocityUpdateSessiona ResourceVelocityUpdateSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceVelocityUpdate() is false
ComplianceoptionalThis method must be implemented if supportsResourceVelocityUpdate() is true.
MethodgetResourceVelocityUpdateSessionForMap
Description

Gets the OsidSession associated with the resource velocity update service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.ResourceVelocityUpdateSessiona ResourceVelocityUpdateSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceVelocityUpdate() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResourceVelocityUpdate() and supportsVisibleFederation() are true
MethodgetResourceVelocityNotificationSession
Description

Gets the OsidSession associated with the resource velocity notification service.

Parametersosid.mapping.path.ResourceVelocityReceiverresourceVelocityReceiverthe notification callback
Returnosid.mapping.path.ResourceVelocityNotificationSessiona ResourceVelocityNotificationSession
ErrorsNULL_ARGUMENT resourceVelocityReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceVelocityNotification() is false
ComplianceoptionalThis method must be implemented if supportsResourceVelocityNotification() is true.
MethodgetResourceVelocityNotificationSessionForMap
Description

Gets the OsidSession associated with the resource velocity notification service for the given map.

Parametersosid.mapping.path.ResourceVelocityReceiverresourceVelocityReceiverthe notification callback
osid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.ResourceVelocityNotificationSessiona ResourceVelocityNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT resourceVelocityReceiver or mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceVelocityNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResourceVelocityNotification() and supportsVisibleFederation() are true
MethodgetMyPathSession
Description

Gets the OsidSession associated with the my path service.

Returnosid.mapping.path.MyPathSessiona MyPathSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMyPath() is false
ComplianceoptionalThis method must be implemented if supportsMyPath() is true.
MethodgetMyPathSessionForMap
Description

Gets the OsidSession associated with the my path service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.MyPathSessiona MyPathSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMyPath() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsMyPath() and supportsVisibleFederation() are true
MethodgetIntersectionLookupSession
Description

Gets the OsidSession associated with the intersection lookup service.

Returnosid.mapping.path.IntersectionLookupSessionan IntersectionLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionLookup() is false
ComplianceoptionalThis method must be implemented if supportsIntersectionLookup() is true.
MethodgetIntersectionLookupSessionForMap
Description

Gets the OsidSession associated with the intersection lookup service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.IntersectionLookupSessionan IntersectionLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIntersectionLookup() and supportsVisibleFederation() are true
MethodgetIntersectionQuerySession
Description

Gets the OsidSession associated with the intersection query service.

Returnosid.mapping.path.IntersectionQuerySessionan IntersectionQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionQuery() is false
ComplianceoptionalThis method must be implemented if supportsIntersectionQuery() is true.
MethodgetIntersectionQuerySessionForMap
Description

Gets the OsidSession associated with the intersection query service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.IntersectionQuerySessionan IntersectionQuerySession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIntersectionQuery() and supportsVisibleFederation() are true
MethodgetIntersectionSearchSession
Description

Gets the OsidSession associated with the intersection search service.

Returnosid.mapping.path.IntersectionSearchSessionan IntersectionSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionSearch() is false
ComplianceoptionalThis method must be implemented if supportsIntersectionSearch() is true.
MethodgetIntersectionSearchSessionForMap
Description

Gets the OsidSession associated with the intersection search service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.IntersectionSearchSessionan IntersectionSearchSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIntersectionSearch() and supportsVisibleFederation() are true
MethodgetIntersectionAdminSession
Description

Gets the OsidSession associated with the intersection administrative service.

Returnosid.mapping.path.IntersectionAdminSessionan IntersectionAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionAdmin() is false
ComplianceoptionalThis method must be implemented if supportsIntersectionAdmin() is true.
MethodgetIntersectionAdminSessionForMap
Description

Gets the OsidSession associated with the intersection administrative service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.IntersectionAdminSessionan IntersectionAdminSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIntersectionAdmin() and supportsVisibleFederation() are true
MethodgetIntersectionNotificationSession
Description

Gets the OsidSession associated with the intersection notification service.

Parametersosid.mapping.path.IntersectionReceiverintersectionReceiverthe notification callback
Returnosid.mapping.path.IntersectionNotificationSessionan IntersectionNotificationSession
ErrorsNULL_ARGUMENT intersectionReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionNotification() is false
ComplianceoptionalThis method must be implemented if supportsIntersectionNotification() is true.
MethodgetIntersectionNotificationSessionForMap
Description

Gets the OsidSession associated with the intersection notification service for the given map.

Parametersosid.mapping.path.IntersectionReceiverintersectionReceiverthe notification callback
osid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.IntersectionNotificationSessionan IntersectionNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT intersectionReceiver or mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIntersectionNotification() and supportsVisibleFederation() are true
MethodgetIntersectionMapSession
Description

Gets the OsidSession to lookup intersection/map mappings.

Returnosid.mapping.path.IntersectionMapSessionan IntersectionMapSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionMap() is false
ComplianceoptionalThis method must be implemented if supportsIntersectionMap() is true.
MethodgetIntersectionMapAssignmentSession
Description

Gets the OsidSession associated with assigning intersections to maps.

Returnosid.mapping.path.IntersectionMapAssignmentSessionan IntersectionMapAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionMapAssignment() is false
ComplianceoptionalThis method must be implemented if supportsIntersectionMapAssignment() is true.
MethodgetIntersectionSmartMapSession
Description

Gets the OsidSession to manage intersection smart maps.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.IntersectionSmartMapSessionan IntersectionSmartMapSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsIntersectionSmartMap() is false
ComplianceoptionalThis method must be implemented if supportsIntersectionSmartMap() is true.
MethodgetSpeedZoneLookupSession
Description

Gets the OsidSession associated with the speed zone lookup service.

Returnosid.mapping.path.SpeedZoneLookupSessiona SpeedZoneLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneLookup() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneLookup() is true.
MethodgetSpeedZoneLookupSessionForMap
Description

Gets the OsidSession associated with the speed zone lookup service for the given map.

Parametersosid.id.IdmapIdthe Id of the map
Returnosid.mapping.path.SpeedZoneLookupSessiona SpeedZoneLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneLookup() and supportsVisibleFederation() are true
MethodgetSpeedZoneQuerySession
Description

Gets the OsidSession associated with the speed zone query service.

Returnosid.mapping.path.SpeedZoneQuerySessiona SpeedZoneQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneQuery() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneQuery() is true.
MethodgetSpeedZoneQuerySessionForMap
Description

Gets the OsidSession associated with the speed zone query service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.SpeedZoneQuerySessiona SpeedZoneQuerySession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneQuery() and supportsVisibleFederation() are true
MethodgetSpeedZoneSearchSession
Description

Gets the OsidSession associated with the speed zone search service.

Returnosid.mapping.path.SpeedZoneSearchSessiona SpeedZoneSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneSearch() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneSearch() is true.
MethodgetSpeedZoneSearchSessionForMap
Description

Gets the OsidSession associated with the speed zone search service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.SpeedZoneSearchSessiona SpeedZoneSearchSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneSearch() and supportsVisibleFederation() are true
MethodgetSpeedZoneAdminSession
Description

Gets the OsidSession associated with the speed zone administration service.

Returnosid.mapping.path.SpeedZoneAdminSessiona SpeedZoneAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneAdmin() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneAdmin() is true.
MethodgetSpeedZoneAdminSessionForMap
Description

Gets the OsidSession associated with the speed zone administration service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.SpeedZoneAdminSessiona SpeedZoneAdminSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneAdmin() and supportsVisibleFederation() are true
MethodgetSpeedZoneNotificationSession
Description

Gets the OsidSession associated with the speed zone notification service.

Parametersosid.mapping.path.SpeedZoneReceiverspeedZoneReceiverthe notification callback
Returnosid.mapping.path.SpeedZoneNotificationSessiona SpeedZoneNotificationSession
ErrorsNULL_ARGUMENT speedZoneReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneNotification() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneNotification() is true.
MethodgetSpeedZoneNotificationSessionForMap
Description

Gets the OsidSession associated with the speed zone notification service for the given map.

Parametersosid.mapping.path.SpeedZoneReceiverspeedZoneReceiverthe notification callback
osid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.SpeedZoneNotificationSessiona SpeedZoneNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT speedZoneReceiver or mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneNotification() and supportsVisibleFederation() are true
MethodgetSpeedZoneMapSession
Description

Gets the OsidSession to lookup speed zone/map mappings.

Returnosid.mapping.path.SpeedZoneMapSessiona SpeedZoneMapSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneMap() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneMap() is true.
MethodgetSpeedZoneMapAssignmentSession
Description

Gets the OsidSession associated with assigning speed zones to maps.

Returnosid.mapping.path.SpeedZoneMapAssignmentSessiona SpeedZoneMapAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneMapAssignment() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneMapAssignment() is true.
MethodgetSpeedZoneSmartMapSession
Description

Gets the OsidSession to manage locatin smart maps.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.SpeedZoneSmartMapSessiona SpeedZoneSmartMapSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSpeedZoneSmartMap() is false
ComplianceoptionalThis method must be implemented if supportsSpeedZoneSmartMap() is true.
MethodgetSignalLookupSession
Description

Gets the OsidSession associated with the signal lookup service.

Returnosid.mapping.path.SignalLookupSessiona SignalLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalLookup() is false
ComplianceoptionalThis method must be implemented if supportsSignalLookup() is true.
MethodgetSignalLookupSessionForMap
Description

Gets the OsidSession associated with the signal lookup service for the given map.

Parametersosid.id.IdmapIdthe Id of the map
Returnosid.mapping.path.SignalLookupSessiona SignalLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSignalLookup() and supportsVisibleFederation() are true
MethodgetSignalQuerySession
Description

Gets the OsidSession associated with the signal query service.

Returnosid.mapping.path.SignalQuerySessiona SignalQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalQuery() is false
ComplianceoptionalThis method must be implemented if supportsSignalQuery() is true.
MethodgetSignalQuerySessionForMap
Description

Gets the OsidSession associated with the signal query service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.SignalQuerySessiona SignalQuerySession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSignalQuery() and supportsVisibleFederation() are true
MethodgetSignalSearchSession
Description

Gets the OsidSession associated with the signal search service.

Returnosid.mapping.path.SignalSearchSessiona SignalSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalSearch() is false
ComplianceoptionalThis method must be implemented if supportsSignalSearch() is true.
MethodgetSignalSearchSessionForMap
Description

Gets the OsidSession associated with the signal search service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.SignalSearchSessiona SignalSearchSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSignalSearch() and supportsVisibleFederation() are true
MethodgetSignalAdminSession
Description

Gets the OsidSession associated with the signal administration service.

Returnosid.mapping.path.SignalAdminSessiona SignalAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalAdmin() is false
ComplianceoptionalThis method must be implemented if supportsSignalAdmin() is true.
MethodgetSignalAdminSessionForMap
Description

Gets the OsidSession associated with the signal administration service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.SignalAdminSessiona SignalAdminSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSignalAdmin() and supportsVisibleFederation() are true
MethodgetSignalNotificationSession
Description

Gets the OsidSession associated with the signal notification service.

Parametersosid.mapping.path.SignalReceiversignalReceiverthe notification callback
Returnosid.mapping.path.SignalNotificationSessiona SignalNotificationSession
ErrorsNULL_ARGUMENT signalReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalNotification() is false
ComplianceoptionalThis method must be implemented if supportsSignalNotification() is true.
MethodgetSignalNotificationSessionForMap
Description

Gets the OsidSession associated with the signal notification service for the given map.

Parametersosid.mapping.path.SignalReceiversignalReceiverthe notification callback
osid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.SignalNotificationSessiona SignalNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT signalReceiver or mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSignalNotification() and supportsVisibleFederation() are true
MethodgetSignalMapSession
Description

Gets the OsidSession to lookup signal/map mappings.

Returnosid.mapping.path.SignalMapSessiona SignalMapSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalMap() is false
ComplianceoptionalThis method must be implemented if supportsSignalMap() is true.
MethodgetSignalMapAssignmentSession
Description

Gets the OsidSession associated with assigning signals to maps.

Returnosid.mapping.path.SignalMapAssignmentSessiona SignalMapAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalMapAssignment() is false
ComplianceoptionalThis method must be implemented if supportsSignalMapAssignment() is true.
MethodgetSignalSmartMapSession
Description

Gets the OsidSession to manage locatin smart maps.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.SignalSmartMapSessiona SignalSmartMapSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSignalSmartMap() is false
ComplianceoptionalThis method must be implemented if supportsSignalSmartMap() is true.
MethodgetResourceSignalNotificationSession
Description

Gets the OsidSession associated with the resource signal notification service.

Parametersosid.mapping.path.ResourceVelocityReceiverresourceSignaReceiverthe notification callback
Returnosid.mapping.path.ResourceSignalNotificationSessiona ResourceSignaNotificationSession
ErrorsNULL_ARGUMENT resourceSignaReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceSignaNotification() is false
ComplianceoptionalThis method must be implemented if supportsResourceSignaNotification() is true.
MethodgetResourceSignaNotificationSessionForMap
Description

Gets the OsidSession associated with the resource signal notification service for the given map.

Parametersosid.mapping.path.ResourceVelocityReceiverresourceSignaReceiverthe notification callback
osid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.ResourceSignalNotificationSessiona ResourceSignaNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT resourceSignaReceiver or mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceSignaNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResourceSignaNotification() and supportsVisibleFederation() are true
MethodgetObstacleLookupSession
Description

Gets the OsidSession associated with the obstacle lookup service.

Returnosid.mapping.path.ObstacleLookupSessionan ObstacleLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleLookup() is false
ComplianceoptionalThis method must be implemented if supportsObstacleLookup() is true.
MethodgetObstacleLookupSessionForMap
Description

Gets the OsidSession associated with the obstacle lookup service for the given map.

Parametersosid.id.IdmapIdthe Id of the map
Returnosid.mapping.path.ObstacleLookupSessionan ObstacleLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsObstacleLookup() and supportsVisibleFederation() are true
MethodgetObstacleQuerySession
Description

Gets the OsidSession associated with the obstacle query service.

Returnosid.mapping.path.ObstacleQuerySessionan ObstacleQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleQuery() is false
ComplianceoptionalThis method must be implemented if supportsObstacleQuery() is true.
MethodgetObstacleQuerySessionForMap
Description

Gets the OsidSession associated with the obstacle query service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.ObstacleQuerySessionan ObstacleQuerySession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsObstacleQuery() and supportsVisibleFederation() are true
MethodgetObstacleSearchSession
Description

Gets the OsidSession associated with the obstacle search service.

Returnosid.mapping.path.ObstacleSearchSessionan ObstacleSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleSearch() is false
ComplianceoptionalThis method must be implemented if supportsObstacleSearch() is true.
MethodgetObstacleSearchSessionForMap
Description

Gets the OsidSession associated with the obstacle search service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.ObstacleSearchSessionan ObstacleSearchSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsObstacleSearch() and supportsVisibleFederation() are true
MethodgetObstacleAdminSession
Description

Gets the OsidSession associated with the obstacle administration service.

Returnosid.mapping.path.ObstacleAdminSessionan ObstacleAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleAdmin() is false
ComplianceoptionalThis method must be implemented if supportsObstacleAdmin() is true.
MethodgetObstacleAdminSessionForMap
Description

Gets the OsidSession associated with the obstacle administration service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.ObstacleAdminSessionan ObstacleAdminSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsObstacleAdmin() and supportsVisibleFederation() are true
MethodgetObstacleNotificationSession
Description

Gets the OsidSession associated with the obstacle notification service.

Parametersosid.mapping.path.ObstacleReceiverobstacleReceiverthe notification callback
Returnosid.mapping.path.ObstacleNotificationSessionan ObstacleNotificationSession
ErrorsNULL_ARGUMENT obstacleReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleNotification() is false
ComplianceoptionalThis method must be implemented if supportsObstacleNotification() is true.
MethodgetObstacleNotificationSessionForMap
Description

Gets the OsidSession associated with the obstacle notification service for the given map.

Parametersosid.mapping.path.ObstacleReceiverobstacleReceiverthe notification callback
osid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.ObstacleNotificationSessionan ObstacleNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT obstacleReceiver or mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsObstacleNotification() and supportsVisibleFederation() are true
MethodgetObstacleMapSession
Description

Gets the OsidSession to lookup obstacle/map mappings.

Returnosid.mapping.path.ObstacleMapSessionan ObstacleMapSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleMap() is false
ComplianceoptionalThis method must be implemented if supportsObstacleMap() is true.
MethodgetObstacleMapAssignmentSession
Description

Gets the OsidSession associated with assigning obstacles to maps.

Returnosid.mapping.path.ObstacleMapAssignmentSessionan ObstacleMapAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleMapAssignment() is false
ComplianceoptionalThis method must be implemented if supportsObstacleMapAssignment() is true.
MethodgetObstacleSmartMapSession
Description

Gets the OsidSession to manage locatin smart maps.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.mapping.path.ObstacleSmartMapSessionan ObstacleSmartMapSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsObstacleSmartMap() is false
ComplianceoptionalThis method must be implemented if supportsObstacleSmartMap() is true.
MethodgetMappingPathBatchManager
Description

Gets a MappingPathBatchManager.

Returnosid.mapping.path.batch.MappingPathBatchManagera MappingPathBatchManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMappingPathBatch() is false
ComplianceoptionalThis method must be implemented if supportsMappingPathBatch() is true.
MethodgetMappingPathRulesManager
Description

Gets a MappingPathRulesManager.

Returnosid.mapping.path.rules.MappingPathRulesManagera MappingPathRulesManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMappingPathRules() is false
ComplianceoptionalThis method must be implemented if supportsMappingPathRules() is true.