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

The mapping profile describes the interoperability among mapping services.

MethodsupportsVisibleFederation
Description

Tests if any map federation is exposed. Federation is exposed when a specific map may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of maps appears as a single map.

Returnboolean true if visible federation is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPathLookup
Description

Tests if looking up paths is supported.

Returnboolean true if path lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPathQuery
Description

Tests if querying paths is supported.

Returnboolean true if path query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPathSearch
Description

Tests if searching paths is supported.

Returnboolean true if path search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPathAdmin
Description

Tests if path administrative service is supported.

Returnboolean true if path administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPathNotification
Description

Tests if a path notification service is supported.

Returnboolean true if path notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPathMap
Description

Tests if a path map lookup service is supported.

Returnboolean true if a path map lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPathMapAssignment
Description

Tests if a path map service is supported.

Returnboolean true if path to map assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPathSmartMap
Description

Tests if a path smart map lookup service is supported.

Returnboolean true if a path smart map service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPathSpatial
Description

Tests if a path spatial lookup service is supported.

Returnboolean true if a path spatial service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPathSpatialDesign
Description

Tests if a path spatial design service is supported.

Returnboolean true if a path spatial design service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsPathTravel
Description

Tests if a path travel service is supported.

Returnboolean true if a path travel service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsResourcePathNotification
Description

Tests if a resource path notification service is supported.

Returnboolean true if a resource path notification service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsResourceVelocity
Description

Tests if a resource velocity service is supported.

Returnboolean true if a resource velocity service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsResourceVelocityUpdate
Description

Tests if a resource velocity update service is supported.

Returnboolean true if a resource velocity update service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsResourceVelocityNotification
Description

Tests if a resource velocity notification service is supported.

Returnboolean true if a resource velocity notification service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsMyPath
Description

Tests if a my path service is supported.

Returnboolean true if a my path service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIntersectionLookup
Description

Tests if an intersection lookup service is supported.

Returnboolean true if an intersection lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIntersectionQuery
Description

Tests if querying intersections is supported.

Returnboolean true if intersection query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIntersectionSearch
Description

Tests if searching intersections is supported.

Returnboolean true if intersection search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIntersectionAdmin
Description

Tests if an intersection administrative service is supported.

Returnboolean true if an intersection administrative service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIntersectionNotification
Description

Tests if an intersection notification service is supported.

Returnboolean true if intersection notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIntersectionMap
Description

Tests if an intersection map lookup service is supported.

Returnboolean true if an intersection map lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIntersectionMapAssignment
Description

Tests if an intersection map service is supported.

Returnboolean true if intersection to map assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsIntersectionSmartMap
Description

Tests if an intersection smart map lookup service is supported.

Returnboolean true if an intersection smart map service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSpeedZoneLookup
Description

Tests if looking up speed zones is supported.

Returnboolean true if speed zone lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSpeedZoneQuery
Description

Tests if querying speed zones is supported.

Returnboolean true if speed zone query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSpeedZoneSearch
Description

Tests if searching speed zones is supported.

Returnboolean true if speed zone search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSpeedZoneAdmin
Description

Tests if speed zone administrative service is supported.

Returnboolean true if speed zone administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSpeedZoneNotification
Description

Tests if a speed zone notification service is supported.

Returnboolean true if speed zone notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSpeedZoneMap
Description

Tests if a speed zone map lookup service is supported.

Returnboolean true if a speed zone map lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSpeedZoneMapAssignment
Description

Tests if a speed zone map assignment service is supported.

Returnboolean true if a speed zone to map assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSpeedZoneSmartMap
Description

Tests if a speed zone smart map service is supported.

Returnboolean true if a speed zone smart map service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSignalLookup
Description

Tests if looking up signals is supported.

Returnboolean true if signal lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSignalQuery
Description

Tests if querying signals is supported.

Returnboolean true if signal query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSignalSearch
Description

Tests if searching signals is supported.

Returnboolean true if signal search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSignalAdmin
Description

Tests if signal administrative service is supported.

Returnboolean true if signal administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSignalNotification
Description

Tests if a signal notification service is supported.

Returnboolean true if signal notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSignalMap
Description

Tests if a signal map lookup service is supported.

Returnboolean true if a signal map lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSignalMapAssignment
Description

Tests if a signal map assignment service is supported.

Returnboolean true if a signal to map assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsSignalSmartMap
Description

Tests if a signal smart map service is supported.

Returnboolean true if a signal smart map service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsResourceSignalNotification
Description

Tests if a resource signal notification service is supported.

Returnboolean true if a resource signal notification service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsObstacleLookup
Description

Tests if looking up obstacles is supported.

Returnboolean true if obstacle lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsObstacleQuery
Description

Tests if querying obstacles is supported.

Returnboolean true if obstacle query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsObstacleSearch
Description

Tests if searching obstacles is supported.

Returnboolean true if obstacle search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsObstacleAdmin
Description

Tests if obstacle administrative service is supported.

Returnboolean true if obstacle administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsObstacleNotification
Description

Tests if an obstacle notification service is supported.

Returnboolean true if obstacle notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsObstacleHierarchy
Description

Tests if an obstacle hierarchy service is supported.

Returnboolean true if obstacle hierarchy is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsObstacleHierarchyDesign
Description

Tests if an obstacle hierarchy design service is supported.

Returnboolean true if obstacle hierarchy design is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsObstacleMap
Description

Tests if an obstacle map lookup service is supported.

Returnboolean true if an obstacle map lookup service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsObstacleMapAssignment
Description

Tests if an obstacle map assignment service is supported.

Returnboolean true if an obstacle to map assignment service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsObstacleSmartMap
Description

Tests if an obstacle smart map service is supported.

Returnboolean true if an obstacle smart map service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsMappingPathBatch
Description

Tests if a batch mapping path service is supported.

Returnboolean true if a mapping path batch service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsMappingPathRules
Description

Tests if a mapping path rules service is supported.

Returnboolean true if a mapping path rules service is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPathRecordTypes
Description

Gets the supported Path record types.

Returnosid.type.TypeLista list containing the supported Path record types
CompliancemandatoryThis method must be implemented.
MethodsupportsPathRecordType
Description

Tests if the given Path record type is supported.

Parametersosid.type.TypepathRecordTypea Type indicating a Path record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT pathRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetPathSearchRecordTypes
Description

Gets the supported Path search record types.

Returnosid.type.TypeLista list containing the supported Path search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsPathSearchRecordType
Description

Tests if the given Path search record type is supported.

Parametersosid.type.TypepathSearchRecordTypea Type indicating a Path search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT pathSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionRecordTypes
Description

Gets the supported Intersection record types.

Returnosid.type.TypeLista list containing the supported Intersection types
CompliancemandatoryThis method must be implemented.
MethodsupportsIntersectionRecordType
Description

Tests if the given Intersection record type is supported.

Parametersosid.type.TypeintersectionRecordTypea Type indicating an Intersection record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT intersectionRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetIntersectionSearchRecordTypes
Description

Gets the supported Intersection search record types.

Returnosid.type.TypeLista list containing the supported Intersection search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsIntersectionSearchRecordType
Description

Tests if the given Intersection search record type is supported.

Parametersosid.type.TypeintersectionSearchRecordTypea Type indicating an Intersection search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT intersectionSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneRecordTypes
Description

Gets the supported SpeedZone record types.

Returnosid.type.TypeLista list containing the supported SpeedZone record types
CompliancemandatoryThis method must be implemented.
MethodsupportsSpeedZoneRecordType
Description

Tests if the given SpeedZone record type is supported.

Parametersosid.type.TypespeedZoneRecordTypea Type indicating a SpeedZone record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT speedZoneRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetSpeedZoneSearchRecordTypes
Description

Gets the supported SpeedZone search types.

Returnosid.type.TypeLista list containing the supported SpeedZone search types
CompliancemandatoryThis method must be implemented.
MethodsupportsSpeedZoneSearchRecordType
Description

Tests if the given SpeedZone search type is supported.

Parametersosid.type.TypespeedZoneSearchRecordTypea Type indicating a SpeedZone search type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT speedZoneSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetSignalRecordTypes
Description

Gets the supported Signal record types.

Returnosid.type.TypeLista list containing the supported Signal record types
CompliancemandatoryThis method must be implemented.
MethodsupportsSignalRecordType
Description

Tests if the given Signal record type is supported.

Parametersosid.type.TypesignalRecordTypea Type indicating a Signal record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT signalRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetSignalSearchRecordTypes
Description

Gets the supported Signal search types.

Returnosid.type.TypeLista list containing the supported Signal search types
CompliancemandatoryThis method must be implemented.
MethodsupportsSignalSearchRecordType
Description

Tests if the given Signal search type is supported.

Parametersosid.type.TypesignalSearchRecordTypea Type indicating a Signal search type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT signalSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetObstacleRecordTypes
Description

Gets the supported Obstacle record types.

Returnosid.type.TypeLista list containing the supported Obstacle record types
CompliancemandatoryThis method must be implemented.
MethodsupportsObstacleRecordType
Description

Tests if the given Obstacle record type is supported.

Parametersosid.type.TypeobstacleRecordTypea Type indicating an Obstacle record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT obstacleRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetObstacleSearchRecordTypes
Description

Gets the supported Obstacle search types.

Returnosid.type.TypeLista list containing the supported Obstacle search types
CompliancemandatoryThis method must be implemented.
MethodsupportsObstacleSearchRecordType
Description

Tests if the given Obstacle search type is supported.

Parametersosid.type.TypeobstacleSearchRecordTypea Type indicating an Obstacle search type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT obstacleSearchRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetResourceVelocityRecordTypes
Description

Gets the supported ResourceVelocity record types.

Returnosid.type.TypeLista list containing the supported ResourceVelocity record types
CompliancemandatoryThis method must be implemented.
MethodsupportsResourceVelocityRecordType
Description

Tests if the given ResourceVelocity record type is supported.

Parametersosid.type.TyperesourceVelocityRecordTypea Type indicating a ResourceVelocity record type
Returnboolean true if the given record type is supported, false otherwise
ErrorsNULL_ARGUMENT resourceVelocityRecordType is null
CompliancemandatoryThis method must be implemented.