Interface MappingPathProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
MappingPathManager, MappingPathProxyManager
public interface MappingPathProfile extends OsidProfile

The mapping profile describes the interoperability among mapping services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      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.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathLookup

      boolean supportsPathLookup()
      Tests if looking up paths is supported.
      Returns:
      true if path lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathQuery

      boolean supportsPathQuery()
      Tests if querying paths is supported.
      Returns:
      true if path query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathSearch

      boolean supportsPathSearch()
      Tests if searching paths is supported.
      Returns:
      true if path search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathAdmin

      boolean supportsPathAdmin()
      Tests if path administrative service is supported.
      Returns:
      true if path administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathNotification

      boolean supportsPathNotification()
      Tests if a path notification service is supported.
      Returns:
      true if path notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathMap

      boolean supportsPathMap()
      Tests if a path map lookup service is supported.
      Returns:
      true if a path map lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathMapAssignment

      boolean supportsPathMapAssignment()
      Tests if a path map service is supported.
      Returns:
      true if path to map assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathSmartMap

      boolean supportsPathSmartMap()
      Tests if a path smart map lookup service is supported.
      Returns:
      true if a path smart map service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathSpatial

      boolean supportsPathSpatial()
      Tests if a path spatial lookup service is supported.
      Returns:
      true if a path spatial service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathSpatialDesign

      boolean supportsPathSpatialDesign()
      Tests if a path spatial design service is supported.
      Returns:
      true if a path spatial design service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathTravel

      boolean supportsPathTravel()
      Tests if a path travel service is supported.
      Returns:
      true if a path travel service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsResourcePathNotification

      boolean supportsResourcePathNotification()
      Tests if a resource path notification service is supported.
      Returns:
      true if a resource path notification service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsResourceVelocity

      boolean supportsResourceVelocity()
      Tests if a resource velocity service is supported.
      Returns:
      true if a resource velocity service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsResourceVelocityUpdate

      boolean supportsResourceVelocityUpdate()
      Tests if a resource velocity update service is supported.
      Returns:
      true if a resource velocity update service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsResourceVelocityNotification

      boolean supportsResourceVelocityNotification()
      Tests if a resource velocity notification service is supported.
      Returns:
      true if a resource velocity notification service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsMyPath

      boolean supportsMyPath()
      Tests if a my path service is supported.
      Returns:
      true if a my path service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIntersectionLookup

      boolean supportsIntersectionLookup()
      Tests if an intersection lookup service is supported.
      Returns:
      true if an intersection lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIntersectionQuery

      boolean supportsIntersectionQuery()
      Tests if querying intersections is supported.
      Returns:
      true if intersection query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIntersectionSearch

      boolean supportsIntersectionSearch()
      Tests if searching intersections is supported.
      Returns:
      true if intersection search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIntersectionAdmin

      boolean supportsIntersectionAdmin()
      Tests if an intersection administrative service is supported.
      Returns:
      true if an intersection administrative service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIntersectionNotification

      boolean supportsIntersectionNotification()
      Tests if an intersection notification service is supported.
      Returns:
      true if intersection notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIntersectionMap

      boolean supportsIntersectionMap()
      Tests if an intersection map lookup service is supported.
      Returns:
      true if an intersection map lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIntersectionMapAssignment

      boolean supportsIntersectionMapAssignment()
      Tests if an intersection map service is supported.
      Returns:
      true if intersection to map assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsIntersectionSmartMap

      boolean supportsIntersectionSmartMap()
      Tests if an intersection smart map lookup service is supported.
      Returns:
      true if an intersection smart map service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSpeedZoneLookup

      boolean supportsSpeedZoneLookup()
      Tests if looking up speed zones is supported.
      Returns:
      true if speed zone lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSpeedZoneQuery

      boolean supportsSpeedZoneQuery()
      Tests if querying speed zones is supported.
      Returns:
      true if speed zone query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSpeedZoneSearch

      boolean supportsSpeedZoneSearch()
      Tests if searching speed zones is supported.
      Returns:
      true if speed zone search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSpeedZoneAdmin

      boolean supportsSpeedZoneAdmin()
      Tests if speed zone administrative service is supported.
      Returns:
      true if speed zone administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSpeedZoneNotification

      boolean supportsSpeedZoneNotification()
      Tests if a speed zone notification service is supported.
      Returns:
      true if speed zone notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSpeedZoneMap

      boolean supportsSpeedZoneMap()
      Tests if a speed zone map lookup service is supported.
      Returns:
      true if a speed zone map lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSpeedZoneMapAssignment

      boolean supportsSpeedZoneMapAssignment()
      Tests if a speed zone map assignment service is supported.
      Returns:
      true if a speed zone to map assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSpeedZoneSmartMap

      boolean supportsSpeedZoneSmartMap()
      Tests if a speed zone smart map service is supported.
      Returns:
      true if a speed zone smart map service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSignalLookup

      boolean supportsSignalLookup()
      Tests if looking up signals is supported.
      Returns:
      true if signal lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSignalQuery

      boolean supportsSignalQuery()
      Tests if querying signals is supported.
      Returns:
      true if signal query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSignalSearch

      boolean supportsSignalSearch()
      Tests if searching signals is supported.
      Returns:
      true if signal search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSignalAdmin

      boolean supportsSignalAdmin()
      Tests if signal administrative service is supported.
      Returns:
      true if signal administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSignalNotification

      boolean supportsSignalNotification()
      Tests if a signal notification service is supported.
      Returns:
      true if signal notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSignalMap

      boolean supportsSignalMap()
      Tests if a signal map lookup service is supported.
      Returns:
      true if a signal map lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSignalMapAssignment

      boolean supportsSignalMapAssignment()
      Tests if a signal map assignment service is supported.
      Returns:
      true if a signal to map assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsSignalSmartMap

      boolean supportsSignalSmartMap()
      Tests if a signal smart map service is supported.
      Returns:
      true if a signal smart map service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsResourceSignalNotification

      boolean supportsResourceSignalNotification()
      Tests if a resource signal notification service is supported.
      Returns:
      true if a resource signal notification service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsObstacleLookup

      boolean supportsObstacleLookup()
      Tests if looking up obstacles is supported.
      Returns:
      true if obstacle lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsObstacleQuery

      boolean supportsObstacleQuery()
      Tests if querying obstacles is supported.
      Returns:
      true if obstacle query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsObstacleSearch

      boolean supportsObstacleSearch()
      Tests if searching obstacles is supported.
      Returns:
      true if obstacle search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsObstacleAdmin

      boolean supportsObstacleAdmin()
      Tests if obstacle administrative service is supported.
      Returns:
      true if obstacle administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsObstacleNotification

      boolean supportsObstacleNotification()
      Tests if an obstacle notification service is supported.
      Returns:
      true if obstacle notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsObstacleHierarchy

      boolean supportsObstacleHierarchy()
      Tests if an obstacle hierarchy service is supported.
      Returns:
      true if obstacle hierarchy is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsObstacleHierarchyDesign

      boolean supportsObstacleHierarchyDesign()
      Tests if an obstacle hierarchy design service is supported.
      Returns:
      true if obstacle hierarchy design is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsObstacleMap

      boolean supportsObstacleMap()
      Tests if an obstacle map lookup service is supported.
      Returns:
      true if an obstacle map lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsObstacleMapAssignment

      boolean supportsObstacleMapAssignment()
      Tests if an obstacle map assignment service is supported.
      Returns:
      true if an obstacle to map assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsObstacleSmartMap

      boolean supportsObstacleSmartMap()
      Tests if an obstacle smart map service is supported.
      Returns:
      true if an obstacle smart map service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsMappingPathBatch

      boolean supportsMappingPathBatch()
      Tests if a batch mapping path service is supported.
      Returns:
      true if a mapping path batch service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsMappingPathRules

      boolean supportsMappingPathRules()
      Tests if a mapping path rules service is supported.
      Returns:
      true if a mapping path rules service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getPathRecordTypes

      TypeList getPathRecordTypes()
      Gets the supported Path record types.
      Returns:
      a list containing the supported Path record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathRecordType

      boolean supportsPathRecordType(Type pathRecordType)
      Tests if the given Path record type is supported.
      Parameters:
      pathRecordType - a Type indicating a Path record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - pathRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getPathSearchRecordTypes

      TypeList getPathSearchRecordTypes()
      Gets the supported Path search record types.
      Returns:
      a list containing the supported Path search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsPathSearchRecordType

      boolean supportsPathSearchRecordType(Type pathSearchRecordType)
      Tests if the given Path search record type is supported.
      Parameters:
      pathSearchRecordType - a Type indicating a Path search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - pathSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getIntersectionRecordTypes

      TypeList getIntersectionRecordTypes()
      Gets the supported Intersection record types.
      Returns:
      a list containing the supported Intersection types
      Compliance:
      mandatory - This method must be implemented.

    • supportsIntersectionRecordType

      boolean supportsIntersectionRecordType(Type intersectionRecordType)
      Tests if the given Intersection record type is supported.
      Parameters:
      intersectionRecordType - a Type indicating an Intersection record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - intersectionRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getIntersectionSearchRecordTypes

      TypeList getIntersectionSearchRecordTypes()
      Gets the supported Intersection search record types.
      Returns:
      a list containing the supported Intersection search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsIntersectionSearchRecordType

      boolean supportsIntersectionSearchRecordType(Type intersectionSearchRecordType)
      Tests if the given Intersection search record type is supported.
      Parameters:
      intersectionSearchRecordType - a Type indicating an Intersection search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - intersectionSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getSpeedZoneRecordTypes

      TypeList getSpeedZoneRecordTypes()
      Gets the supported SpeedZone record types.
      Returns:
      a list containing the supported SpeedZone record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsSpeedZoneRecordType

      boolean supportsSpeedZoneRecordType(Type speedZoneRecordType)
      Tests if the given SpeedZone record type is supported.
      Parameters:
      speedZoneRecordType - a Type indicating a SpeedZone record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - speedZoneRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getSpeedZoneSearchRecordTypes

      TypeList getSpeedZoneSearchRecordTypes()
      Gets the supported SpeedZone search types.
      Returns:
      a list containing the supported SpeedZone search types
      Compliance:
      mandatory - This method must be implemented.

    • supportsSpeedZoneSearchRecordType

      boolean supportsSpeedZoneSearchRecordType(Type speedZoneSearchRecordType)
      Tests if the given SpeedZone search type is supported.
      Parameters:
      speedZoneSearchRecordType - a Type indicating a SpeedZone search type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - speedZoneSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getSignalRecordTypes

      TypeList getSignalRecordTypes()
      Gets the supported Signal record types.
      Returns:
      a list containing the supported Signal record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsSignalRecordType

      boolean supportsSignalRecordType(Type signalRecordType)
      Tests if the given Signal record type is supported.
      Parameters:
      signalRecordType - a Type indicating a Signal record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - signalRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getSignalSearchRecordTypes

      TypeList getSignalSearchRecordTypes()
      Gets the supported Signal search types.
      Returns:
      a list containing the supported Signal search types
      Compliance:
      mandatory - This method must be implemented.

    • supportsSignalSearchRecordType

      boolean supportsSignalSearchRecordType(Type signalSearchRecordType)
      Tests if the given Signal search type is supported.
      Parameters:
      signalSearchRecordType - a Type indicating a Signal search type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - signalSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getObstacleRecordTypes

      TypeList getObstacleRecordTypes()
      Gets the supported Obstacle record types.
      Returns:
      a list containing the supported Obstacle record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsObstacleRecordType

      boolean supportsObstacleRecordType(Type obstacleRecordType)
      Tests if the given Obstacle record type is supported.
      Parameters:
      obstacleRecordType - a Type indicating an Obstacle record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - obstacleRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getObstacleSearchRecordTypes

      TypeList getObstacleSearchRecordTypes()
      Gets the supported Obstacle search types.
      Returns:
      a list containing the supported Obstacle search types
      Compliance:
      mandatory - This method must be implemented.

    • supportsObstacleSearchRecordType

      boolean supportsObstacleSearchRecordType(Type obstacleSearchRecordType)
      Tests if the given Obstacle search type is supported.
      Parameters:
      obstacleSearchRecordType - a Type indicating an Obstacle search type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - obstacleSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getResourceVelocityRecordTypes

      TypeList getResourceVelocityRecordTypes()
      Gets the supported ResourceVelocity record types.
      Returns:
      a list containing the supported ResourceVelocity record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsResourceVelocityRecordType

      boolean supportsResourceVelocityRecordType(Type resourceVelocityRecordType)
      Tests if the given ResourceVelocity record type is supported.
      Parameters:
      resourceVelocityRecordType - a Type indicating a ResourceVelocity record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - resourceVelocityRecordType is null
      Compliance:
      mandatory - This method must be implemented.