Interface MappingPathProxyManager
- All Superinterfaces:
AutoCloseable, Closeable, MappingPathProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable
The mapping proxy manager provides access to rules sessions and
provides interoperability tests for various aspects of this service.
Methods in this manager pass a Proxy for passing information from
server environments. 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
-
Method Summary
Modifier and TypeMethodDescriptiongetIntersectionAdminSession(Proxy proxy) Gets theOsidSessionassociated with the intersection administrative service.getIntersectionAdminSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the intersection administrative service for the given map.Gets theOsidSessionassociated with the intersection lookup service.getIntersectionLookupSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the intersection lookup service for the given map.Gets theOsidSessionassociated with assigning intersections to maps.getIntersectionMapSession(Proxy proxy) Gets theOsidSessionto lookup intersection/map mappings.getIntersectionNotificationSession(IntersectionReceiver intersectionReceiver, Proxy proxy) Gets theOsidSessionassociated with the intersection notification service.getIntersectionNotificationSessionForMap(IntersectionReceiver intersectionReceiver, Id mapId, Proxy proxy) Gets theOsidSessionassociated with the intersection notification service for the given map.getIntersectionQuerySession(Proxy proxy) Gets theOsidSessionassociated with the intersection query service.getIntersectionQuerySessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the intersection query service for the given map.Gets theOsidSessionassociated with the intersection search service.getIntersectionSearchSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the intersection search service for the given map.getIntersectionSmartMapSession(Id mapId, Proxy proxy) Gets theOsidSessionto manage intersection smart maps.Gets aMappingPathBatchproxyManager.Gets aMappingPathRulesProxyManager.getMyPathSession(Proxy proxy) Gets theOsidSessionassociated with the my path service.getMyPathSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the my path service for the given map.getObstacleAdminSession(Proxy proxy) Gets theOsidSessionassociated with the obstacle administration service.getObstacleAdminSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the obstacle administration service for the given map.getObstacleLookupSession(Proxy proxy) Gets theOsidSessionassociated with the obstacle lookup service.getObstacleLookupSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the obstacle lookup service for the given map.Gets theOsidSessionassociated with assigning obstacles to maps.getObstacleMapSession(Proxy proxy) Gets theOsidSessionto lookup obstacle/map mappings.getObstacleNotificationSession(ObstacleReceiver obstacleReceiver, Proxy proxy) Gets theOsidSessionassociated with the obstacle notification service.getObstacleNotificationSessionForMap(ObstacleReceiver obstacleReceiver, Id mapId, Proxy proxy) Gets theOsidSessionassociated with the obstacle notification service for the given map.getObstacleQuerySession(Proxy proxy) Gets theOsidSessionassociated with the obstacle query service.getObstacleQuerySessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the obstacle query service for the given map.getObstacleSearchSession(Proxy proxy) Gets theOsidSessionassociated with the obstacle search service.getObstacleSearchSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the obstacle search service for the given map.getObstacleSmartMapSession(Id mapId, Proxy proxy) Gets theOsidSessionto manage locatin smart maps.getPathAdminSession(Proxy proxy) Gets theOsidSessionassociated with the path administration service.getPathAdminSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the path administration service for the given map.getPathLookupSession(Proxy proxy) Gets theOsidSessionassociated with the path lookup service.getPathLookupSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the path lookup service for the given map.getPathMapAssignmentSession(Proxy proxy) Gets theOsidSessionassociated with assigning paths to maps.getPathMapSession(Proxy proxy) Gets theOsidSessionto lookup path/map mappings.getPathNotificationSession(PathReceiver pathReceiver, Proxy proxy) Gets theOsidSessionassociated with the path notification service.getPathNotificationSessionForMap(PathReceiver pathReceiver, Id mapId, Proxy proxy) Gets theOsidSessionassociated with the path notification service for the given map.getPathQuerySession(Proxy proxy) Gets theOsidSessionassociated with the path query service.getPathQuerySessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the path query service for the given map.getPathSearchSession(Proxy proxy) Gets theOsidSessionassociated with the path search service.getPathSearchSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the path search service for the given map.getPathSmartMapSession(Id mapId, Proxy proxy) Gets theOsidSessionto manage path smart maps.getPathSpatialDesignSession(Proxy proxy) Gets theOsidSessionassociated with the path spatial design service.getPathSpatialDesignSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the path spatial design service for the given map.getPathSpatialSession(Proxy proxy) Gets theOsidSessionassociated with the path spatial service.getPathSpatialSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the path spatial service for the given map.getPathTravelSession(Proxy proxy) Gets theOsidSessionassociated with the path travel service.getPathTravelSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the path travel service for the given map.getResourcePathNotificationSession(ResourcePathReceiver resourcePathReceiver, Proxy proxy) Gets theOsidSessionassociated with the resource path notification service.getResourcePathNotificationSessionForMap(ResourcePathReceiver resourcePathReceiver, Id mapId, Proxy proxy) Gets theOsidSessionassociated with the resource path notification service for the given map.getResourceSignalNotificationSession(ResourceVelocityReceiver resourceSignalReceiver, Proxy proxy) Gets theOsidSessionassociated with the resource signal notification service.getResourceSignalNotificationSessionForMap(ResourceVelocityReceiver resourceSignalReceiver, Id mapId, Proxy proxy) Gets theOsidSessionassociated with the resource signal notification service for the given map.getResourceVelocityNotificationSession(ResourceVelocityReceiver resourceVelocityReceiver, Proxy proxy) Gets theOsidSessionassociated with the resource velocity notification service.getResourceVelocityNotificationSessionForMap(ResourceVelocityReceiver resourceVelocityReceiver, Id mapId, Proxy proxy) Gets theOsidSessionassociated with the resource velocity notification service for the given map.getResourceVelocitySession(Proxy proxy) Gets theOsidSessionassociated with the resource velocity service.getResourceVelocitySessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the resource velocity service for the given map.Gets theOsidSessionassociated with the resource velocity update service.getResourceVelocityUpdateSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the resource velocity update service for the given map.getSignalAdminSession(Proxy proxy) Gets theOsidSessionassociated with the signal administration service.getSignalAdminSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the signal administration service for the given map.getSignalLookupSession(Proxy proxy) Gets theOsidSessionassociated with the signal lookup service.getSignalLookupSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the signal lookup service for the given map.Gets theOsidSessionassociated with assigning signals to maps.getSignalMapSession(Proxy proxy) Gets theOsidSessionto lookup signal/map mappings.getSignalNotificationSession(SignalReceiver signalReceiver, Proxy proxy) Gets theOsidSessionassociated with the signal notification service.getSignalNotificationSessionForMap(SignalReceiver signalReceiver, Id mapId, Proxy proxy) Gets theOsidSessionassociated with the signal notification service for the given map.getSignalQuerySession(Proxy proxy) Gets theOsidSessionassociated with the signal query service.getSignalQuerySessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the signal query service for the given map.getSignalSearchSession(Proxy proxy) Gets theOsidSessionassociated with the signal search service.getSignalSearchSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the signal search service for the given map.getSignalSmartMapSession(Id mapId, Proxy proxy) Gets theOsidSessionto manage signal smart maps.getSpeedZoneAdminSession(Proxy proxy) Gets theOsidSessionassociated with the speed zone administration service.getSpeedZoneAdminSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the speed zone administration service for the given map.getSpeedZoneLookupSession(Proxy proxy) Gets theOsidSessionassociated with the speed zone lookup service.getSpeedZoneLookupSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the speed zone lookup service for the given map.Gets theOsidSessionassociated with assigning speed zones to maps.getSpeedZoneMapSession(Proxy proxy) Gets theOsidSessionto lookup speed zone/map mappings.getSpeedZoneNotificationSession(SpeedZoneReceiver speedZoneReceiver, Proxy proxy) Gets theOsidSessionassociated with the speed zone notification service.getSpeedZoneNotificationSessionForMap(SpeedZoneReceiver speedZoneReceiver, Id mapId, Proxy proxy) Gets theOsidSessionassociated with the speed zone notification service for the given map.getSpeedZoneQuerySession(Proxy proxy) Gets theOsidSessionassociated with the speed zone query service.getSpeedZoneQuerySessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the speed zone query service for the given map.getSpeedZoneSearchSession(Proxy proxy) Gets theOsidSessionassociated with the speed zone search service.getSpeedZoneSearchSessionForMap(Id mapId, Proxy proxy) Gets theOsidSessionassociated with the speed zone search service for the given map.getSpeedZoneSmartMapSession(Id mapId, Proxy proxy) Gets theOsidSessionto manage speed zone smart maps.Methods inherited from interface MappingPathProfile
getIntersectionRecordTypes, getIntersectionSearchRecordTypes, getObstacleRecordTypes, getObstacleSearchRecordTypes, getPathRecordTypes, getPathSearchRecordTypes, getResourceVelocityRecordTypes, getSignalRecordTypes, getSignalSearchRecordTypes, getSpeedZoneRecordTypes, getSpeedZoneSearchRecordTypes, supportsIntersectionAdmin, supportsIntersectionLookup, supportsIntersectionMap, supportsIntersectionMapAssignment, supportsIntersectionNotification, supportsIntersectionQuery, supportsIntersectionRecordType, supportsIntersectionSearch, supportsIntersectionSearchRecordType, supportsIntersectionSmartMap, supportsMappingPathBatch, supportsMappingPathRules, supportsMyPath, supportsObstacleAdmin, supportsObstacleHierarchy, supportsObstacleHierarchyDesign, supportsObstacleLookup, supportsObstacleMap, supportsObstacleMapAssignment, supportsObstacleNotification, supportsObstacleQuery, supportsObstacleRecordType, supportsObstacleSearch, supportsObstacleSearchRecordType, supportsObstacleSmartMap, supportsPathAdmin, supportsPathLookup, supportsPathMap, supportsPathMapAssignment, supportsPathNotification, supportsPathQuery, supportsPathRecordType, supportsPathSearch, supportsPathSearchRecordType, supportsPathSmartMap, supportsPathSpatial, supportsPathSpatialDesign, supportsPathTravel, supportsResourcePathNotification, supportsResourceSignalNotification, supportsResourceVelocity, supportsResourceVelocityNotification, supportsResourceVelocityRecordType, supportsResourceVelocityUpdate, supportsSignalAdmin, supportsSignalLookup, supportsSignalMap, supportsSignalMapAssignment, supportsSignalNotification, supportsSignalQuery, supportsSignalRecordType, supportsSignalSearch, supportsSignalSearchRecordType, supportsSignalSmartMap, supportsSpeedZoneAdmin, supportsSpeedZoneLookup, supportsSpeedZoneMap, supportsSpeedZoneMapAssignment, supportsSpeedZoneNotification, supportsSpeedZoneQuery, supportsSpeedZoneRecordType, supportsSpeedZoneSearch, supportsSpeedZoneSearchRecordType, supportsSpeedZoneSmartMap, supportsVisibleFederationModifier and TypeMethodDescriptionGets the supportedIntersectionrecord types.Gets the supportedIntersectionsearch record types.Gets the supportedObstaclerecord types.Gets the supportedObstaclesearch types.Gets the supportedPathrecord types.Gets the supportedPathsearch record types.Gets the supportedResourceVelocityrecord types.Gets the supportedSignalrecord types.Gets the supportedSignalsearch types.Gets the supportedSpeedZonerecord types.Gets the supportedSpeedZonesearch types.booleanTests if an intersection administrative service is supported.booleanTests if an intersection lookup service is supported.booleanTests if an intersection map lookup service is supported.booleanTests if an intersection map service is supported.booleanTests if an intersection notification service is supported.booleanTests if querying intersections is supported.booleansupportsIntersectionRecordType(Type intersectionRecordType) Tests if the givenIntersectionrecord type is supported.booleanTests if searching intersections is supported.booleansupportsIntersectionSearchRecordType(Type intersectionSearchRecordType) Tests if the givenIntersectionsearch record type is supported.booleanTests if an intersection smart map lookup service is supported.booleanTests if a batch mapping path service is supported.booleanTests if a mapping path rules service is supported.booleanTests if a my path service is supported.booleanTests if obstacle administrative service is supported.booleanTests if an obstacle hierarchy service is supported.booleanTests if an obstacle hierarchy design service is supported.booleanTests if looking up obstacles is supported.booleanTests if an obstacle map lookup service is supported.booleanTests if an obstacle map assignment service is supported.booleanTests if an obstacle notification service is supported.booleanTests if querying obstacles is supported.booleansupportsObstacleRecordType(Type obstacleRecordType) Tests if the givenObstaclerecord type is supported.booleanTests if searching obstacles is supported.booleansupportsObstacleSearchRecordType(Type obstacleSearchRecordType) Tests if the givenObstaclesearch type is supported.booleanTests if an obstacle smart map service is supported.booleanTests if path administrative service is supported.booleanTests if looking up paths is supported.booleanTests if a path map lookup service is supported.booleanTests if a path map service is supported.booleanTests if a path notification service is supported.booleanTests if querying paths is supported.booleansupportsPathRecordType(Type pathRecordType) Tests if the givenPathrecord type is supported.booleanTests if searching paths is supported.booleansupportsPathSearchRecordType(Type pathSearchRecordType) Tests if the givenPathsearch record type is supported.booleanTests if a path smart map lookup service is supported.booleanTests if a path spatial lookup service is supported.booleanTests if a path spatial design service is supported.booleanTests if a path travel service is supported.booleanTests if a resource path notification service is supported.booleanTests if a resource signal notification service is supported.booleanTests if a resource velocity service is supported.booleanTests if a resource velocity notification service is supported.booleansupportsResourceVelocityRecordType(Type resourceVelocityRecordType) Tests if the givenResourceVelocityrecord type is supported.booleanTests if a resource velocity update service is supported.booleanTests if signal administrative service is supported.booleanTests if looking up signals is supported.booleanTests if a signal map lookup service is supported.booleanTests if a signal map assignment service is supported.booleanTests if a signal notification service is supported.booleanTests if querying signals is supported.booleansupportsSignalRecordType(Type signalRecordType) Tests if the givenSignalrecord type is supported.booleanTests if searching signals is supported.booleansupportsSignalSearchRecordType(Type signalSearchRecordType) Tests if the givenSignalsearch type is supported.booleanTests if a signal smart map service is supported.booleanTests if speed zone administrative service is supported.booleanTests if looking up speed zones is supported.booleanTests if a speed zone map lookup service is supported.booleanTests if a speed zone map assignment service is supported.booleanTests if a speed zone notification service is supported.booleanTests if querying speed zones is supported.booleansupportsSpeedZoneRecordType(Type speedZoneRecordType) Tests if the givenSpeedZonerecord type is supported.booleanTests if searching speed zones is supported.booleansupportsSpeedZoneSearchRecordType(Type speedZoneSearchRecordType) Tests if the givenSpeedZonesearch type is supported.booleanTests if a speed zone smart map service is supported.booleanTests if any map federation is exposed.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface OsidProxyManager
closeMethods inherited from interface OsidProxyManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getPathLookupSession
Gets theOsidSessionassociated with the path lookup service.- Parameters:
proxy- a proxy- Returns:
- a
PathLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathLookup()} is {@code true} .
-
getPathLookupSessionForMap
PathLookupSession getPathLookupSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the path lookup service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
PathLookupSession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getPathQuerySession
Gets theOsidSessionassociated with the path query service.- Parameters:
proxy- a proxy- Returns:
- a
PathQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathQuery()} is {@code true} .
-
getPathQuerySessionForMap
PathQuerySession getPathQuerySessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the path query service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
PathQuerySession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getPathSearchSession
Gets theOsidSessionassociated with the path search service.- Parameters:
proxy- a proxy- Returns:
- a
PathSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathSearch()} is {@code true} .
-
getPathSearchSessionForMap
PathSearchSession getPathSearchSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the path search service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
PathSearchSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getPathAdminSession
Gets theOsidSessionassociated with the path administration service.- Parameters:
proxy- a proxy- Returns:
- a
PathAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathAdmin()} is {@code true} .
-
getPathAdminSessionForMap
PathAdminSession getPathAdminSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the path administration service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
PathAdminSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getPathNotificationSession
PathNotificationSession getPathNotificationSession(PathReceiver pathReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the path notification service.- Parameters:
pathReceiver- the notification callbackproxy- a proxy- Returns:
- a
PathNotificationSession - Throws:
NullArgumentException-pathReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathNotification()} is {@code true} .
-
getPathNotificationSessionForMap
PathNotificationSession getPathNotificationSessionForMap(PathReceiver pathReceiver, Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the path notification service for the given map.- Parameters:
pathReceiver- the notification callbackmapId- theIdof theMapproxy- a proxy- Returns:
- a
PathNotificationSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-pathReceiver, mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getPathMapSession
Gets theOsidSessionto lookup path/map mappings.- Parameters:
proxy- a proxy- Returns:
- a
PathMapSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathMap()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathMap()} is {@code true} .
-
getPathMapAssignmentSession
Gets theOsidSessionassociated with assigning paths to maps.- Parameters:
proxy- a proxy- Returns:
- a
PathMapAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathMapAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathMapAssignment()} is {@code true} .
-
getPathSmartMapSession
PathSmartMapSession getPathSmartMapSession(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage path smart maps.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
PathSmartMapSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathSmartMap()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathSmartMap()} is {@code true} .
-
getPathSpatialSession
Gets theOsidSessionassociated with the path spatial service.- Parameters:
proxy- a proxy- Returns:
- a
PathSpatialSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathSpatial()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathSpatial()} is {@code true} .
-
getPathSpatialSessionForMap
PathSpatialSession getPathSpatialSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the path spatial service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
PathSpatialSession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathSpatial()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathSpatial()} and {@code supportsVisibleFederation()} are {@code true}
-
getPathSpatialDesignSession
Gets theOsidSessionassociated with the path spatial design service.- Parameters:
proxy- a proxy- Returns:
- a
PathSpatialDesignSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathSpatialDesign()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathSpatialDsign()} is {@code true} .
-
getPathSpatialDesignSessionForMap
PathSpatialDesignSession getPathSpatialDesignSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the path spatial design service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
PathSpatialDesignSession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathSpatialDesign()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathSpatialDesign()} and {@code supportsVisibleFederation()} are {@code true}
-
getPathTravelSession
Gets theOsidSessionassociated with the path travel service.- Parameters:
proxy- a proxy- Returns:
- a
PathTravelSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathTravel()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathTravel()} is {@code true} .
-
getPathTravelSessionForMap
PathTravelSession getPathTravelSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the path travel service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
PathTravelSession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsPathTravel()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsPathTravel()} and {@code supportsVisibleFederation()} are {@code true}
-
getResourcePathNotificationSession
ResourcePathNotificationSession getResourcePathNotificationSession(ResourcePathReceiver resourcePathReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the resource path notification service.- Parameters:
resourcePathReceiver- the notification callbackproxy- a proxy- Returns:
- a
ResourcePathNotificationSession - Throws:
NullArgumentException-resourcePathReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsResourcePathNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsResourcePathNotification()} is {@code true} .
-
getResourcePathNotificationSessionForMap
ResourcePathNotificationSession getResourcePathNotificationSessionForMap(ResourcePathReceiver resourcePathReceiver, Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the resource path notification service for the given map.- Parameters:
resourcePathReceiver- the notification callbackmapId- theIdof theMapproxy- a proxy- Returns:
- a
ResourcePathNotificationSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-resourcePathReceiver, mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsResourcePathNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsResourcePathNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getResourceVelocitySession
Gets theOsidSessionassociated with the resource velocity service.- Parameters:
proxy- a proxy- Returns:
- a
ResourceVelocitySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsResourceVelocity()isfalse- Compliance:
optional- This method must be implemented if {@code supportsResourceVelocity()} is {@code true} .
-
getResourceVelocitySessionForMap
ResourceVelocitySession getResourceVelocitySessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the resource velocity service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
ResourceVelocitySession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsResourceVelocity()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsResourceVelocity()} and {@code supportsVisibleFederation()} are {@code true}
-
getResourceVelocityUpdateSession
ResourceVelocityUpdateSession getResourceVelocityUpdateSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the resource velocity update service.- Parameters:
proxy- a proxy- Returns:
- a
ResourceVelocityUpdateSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsResourceVelocityUpdate()isfalse- Compliance:
optional- This method must be implemented if {@code supportsResourceVelocityUpdate()} is {@code true} .
-
getResourceVelocityUpdateSessionForMap
ResourceVelocityUpdateSession getResourceVelocityUpdateSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the resource velocity update service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
ResourceVelocityUpdateSession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsResourceVelocityUpdate()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsResourceVelocityUpdate()} and {@code supportsVisibleFederation()} are {@code true}
-
getResourceVelocityNotificationSession
ResourceVelocityNotificationSession getResourceVelocityNotificationSession(ResourceVelocityReceiver resourceVelocityReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the resource velocity notification service.- Parameters:
resourceVelocityReceiver- the notification callbackproxy- a proxy- Returns:
- a
ResourceVelocityNotificationSession - Throws:
NullArgumentException-resourceVelocityReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsResourceVelocityNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsResourceVelocityNotification()} is {@code true} .
-
getResourceVelocityNotificationSessionForMap
ResourceVelocityNotificationSession getResourceVelocityNotificationSessionForMap(ResourceVelocityReceiver resourceVelocityReceiver, Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the resource velocity notification service for the given map.- Parameters:
resourceVelocityReceiver- the notification callbackmapId- theIdof theMapproxy- a proxy- Returns:
- a
ResourceVelocityNotificationSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-resourceVelocityReceiver, mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsResourceVelocityNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsResourceVelocityNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getMyPathSession
Gets theOsidSessionassociated with the my path service.- Parameters:
proxy- a proxy- Returns:
- a
MyPathSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsMyPath()isfalse- Compliance:
optional- This method must be implemented if {@code supportsMyPath()} is {@code true} .
-
getMyPathSessionForMap
MyPathSession getMyPathSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the my path service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
MyPathSession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsMyPath()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsMyPath()} and {@code supportsVisibleFederation()} are {@code true}
-
getIntersectionLookupSession
Gets theOsidSessionassociated with the intersection lookup service.- Parameters:
proxy- a proxy- Returns:
- an
IntersectionLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIntersectionLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIntersectionLookup()} is {@code true} .
-
getIntersectionLookupSessionForMap
IntersectionLookupSession getIntersectionLookupSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the intersection lookup service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- an
IntersectionLookupSession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIntersectionLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIntersectionLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getIntersectionQuerySession
Gets theOsidSessionassociated with the intersection query service.- Parameters:
proxy- a proxy- Returns:
- an
IntersectionQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIntersectionQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIntersectionQuery()} is {@code true} .
-
getIntersectionQuerySessionForMap
IntersectionQuerySession getIntersectionQuerySessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the intersection query service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- an
IntersectionQuerySession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIntersectionQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIntersectionQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getIntersectionSearchSession
Gets theOsidSessionassociated with the intersection search service.- Parameters:
proxy- a proxy- Returns:
- an
IntersectionSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIntersectionSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIntersectionSearch()} is {@code true} .
-
getIntersectionSearchSessionForMap
IntersectionSearchSession getIntersectionSearchSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the intersection search service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- an
IntersectionSearchSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIntersectionSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIntersectionSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getIntersectionAdminSession
Gets theOsidSessionassociated with the intersection administrative service.- Parameters:
proxy- a proxy- Returns:
- an
IntersectionAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIntersectionAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIntersectionAdmin()} is {@code true} .
-
getIntersectionAdminSessionForMap
IntersectionAdminSession getIntersectionAdminSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the intersection administrative service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- an
IntersectionAdminSession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIntersectionAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIntersectionAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getIntersectionNotificationSession
IntersectionNotificationSession getIntersectionNotificationSession(IntersectionReceiver intersectionReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the intersection notification service.- Parameters:
intersectionReceiver- the notification callbackproxy- a proxy- Returns:
- an
IntersectionNotificationSession - Throws:
NullArgumentException-intersectionReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIntersectionNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIntersectionNotification()} is {@code true} .
-
getIntersectionNotificationSessionForMap
IntersectionNotificationSession getIntersectionNotificationSessionForMap(IntersectionReceiver intersectionReceiver, Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the intersection notification service for the given map.- Parameters:
intersectionReceiver- the notification callbackmapId- theIdof theMapproxy- a proxy- Returns:
- an
IntersectionNotificationSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-intersectionReceiver, mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIntersectionNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIntersectionNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getIntersectionMapSession
Gets theOsidSessionto lookup intersection/map mappings.- Parameters:
proxy- a proxy- Returns:
- an
IntersectionMapSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIntersectionMap()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIntersectionMap()} is {@code true} .
-
getIntersectionMapAssignmentSession
IntersectionMapAssignmentSession getIntersectionMapAssignmentSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with assigning intersections to maps.- Parameters:
proxy- a proxy- Returns:
- an
IntersectionMapAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIntersectionMapAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIntersectionMapAssignment()} is {@code true} .
-
getIntersectionSmartMapSession
IntersectionSmartMapSession getIntersectionSmartMapSession(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage intersection smart maps.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- an
IntersectionSmartMapSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIntersectionSmartMap()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIntersectionSmartMap()} is {@code true} .
-
getSpeedZoneLookupSession
Gets theOsidSessionassociated with the speed zone lookup service.- Parameters:
proxy- a proxy- Returns:
- a
SpeedZoneLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSpeedZoneLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSpeedZoneLookup()} is {@code true} .
-
getSpeedZoneLookupSessionForMap
SpeedZoneLookupSession getSpeedZoneLookupSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the speed zone lookup service for the given map.- Parameters:
mapId- theIdof the mapproxy- a proxy- Returns:
- a
SpeedZoneLookupSession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSpeedZoneLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSpeedZoneLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getSpeedZoneQuerySession
Gets theOsidSessionassociated with the speed zone query service.- Parameters:
proxy- a proxy- Returns:
- a
SpeedZoneQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSpeedZoneQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSpeedZoneQuery()} is {@code true} .
-
getSpeedZoneQuerySessionForMap
SpeedZoneQuerySession getSpeedZoneQuerySessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the speed zone query service for the given map.- Parameters:
mapId- theIdof the mapproxy- a proxy- Returns:
- a
SpeedZoneQuerySession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSpeedZoneQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSpeedZoneQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getSpeedZoneSearchSession
Gets theOsidSessionassociated with the speed zone search service.- Parameters:
proxy- a proxy- Returns:
- a
SpeedZoneSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSpeedZoneSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSpeedZoneSearch()} is {@code true} .
-
getSpeedZoneSearchSessionForMap
SpeedZoneSearchSession getSpeedZoneSearchSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the speed zone search service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
SpeedZoneSearchSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSpeedZoneSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSpeedZoneSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getSpeedZoneAdminSession
Gets theOsidSessionassociated with the speed zone administration service.- Parameters:
proxy- a proxy- Returns:
- a
SpeedZoneAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSpeedZoneAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSpeedZoneAdmin()} is {@code true} .
-
getSpeedZoneAdminSessionForMap
SpeedZoneAdminSession getSpeedZoneAdminSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the speed zone administration service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
SpeedZoneAdminSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSpeedZoneAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSpeedZoneAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getSpeedZoneNotificationSession
SpeedZoneNotificationSession getSpeedZoneNotificationSession(SpeedZoneReceiver speedZoneReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the speed zone notification service.- Parameters:
speedZoneReceiver- the notification callbackproxy- a proxy- Returns:
- a
SpeedZoneNotificationSession - Throws:
NullArgumentException-speedZoneReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSpeedZoneNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSpeedZoneNotification()} is {@code true} .
-
getSpeedZoneNotificationSessionForMap
SpeedZoneNotificationSession getSpeedZoneNotificationSessionForMap(SpeedZoneReceiver speedZoneReceiver, Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the speed zone notification service for the given map.- Parameters:
speedZoneReceiver- the notification callbackmapId- theIdof theMapproxy- a proxy- Returns:
- a
SpeedZoneNotificationSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-speedZoneReceiver, mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSpeedZoneNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSpeedZoneNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getSpeedZoneMapSession
Gets theOsidSessionto lookup speed zone/map mappings.- Parameters:
proxy- a proxy- Returns:
- a
SpeedZoneMapSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSpeedZoneMap()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSpeedZoneMap()} is {@code true} .
-
getSpeedZoneMapAssignmentSession
SpeedZoneMapAssignmentSession getSpeedZoneMapAssignmentSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with assigning speed zones to maps.- Parameters:
proxy- a proxy- Returns:
- a
SpeedZoneMapAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSpeedZoneMapAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSpeedZoneMapAssignment()} is {@code true} .
-
getSpeedZoneSmartMapSession
SpeedZoneSmartMapSession getSpeedZoneSmartMapSession(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage speed zone smart maps.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
SpeedZoneSmartMapSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSpeedZoneSmartMap()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSpeedZoneSmartMap()} is {@code true} .
-
getSignalLookupSession
Gets theOsidSessionassociated with the signal lookup service.- Parameters:
proxy- a proxy- Returns:
- a
SignalLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSignalLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSignalLookup()} is {@code true} .
-
getSignalLookupSessionForMap
SignalLookupSession getSignalLookupSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the signal lookup service for the given map.- Parameters:
mapId- theIdof the mapproxy- a proxy- Returns:
- a
SignalLookupSession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSignalLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSignalLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getSignalQuerySession
Gets theOsidSessionassociated with the signal query service.- Parameters:
proxy- a proxy- Returns:
- a
SignalQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSignalQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSignalQuery()} is {@code true} .
-
getSignalQuerySessionForMap
SignalQuerySession getSignalQuerySessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the signal query service for the given map.- Parameters:
mapId- theIdof the mapproxy- a proxy- Returns:
- a
SignalQuerySession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSignalQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSignalQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getSignalSearchSession
Gets theOsidSessionassociated with the signal search service.- Parameters:
proxy- a proxy- Returns:
- a
SignalSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSignalSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSignalSearch()} is {@code true} .
-
getSignalSearchSessionForMap
SignalSearchSession getSignalSearchSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the signal search service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
SignalSearchSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSignalSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSignalSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getSignalAdminSession
Gets theOsidSessionassociated with the signal administration service.- Parameters:
proxy- a proxy- Returns:
- a
SignalAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSignalAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSignalAdmin()} is {@code true} .
-
getSignalAdminSessionForMap
SignalAdminSession getSignalAdminSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the signal administration service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
SignalAdminSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSignalAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSignalAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getSignalNotificationSession
SignalNotificationSession getSignalNotificationSession(SignalReceiver signalReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the signal notification service.- Parameters:
signalReceiver- the notification callbackproxy- a proxy- Returns:
- a
SignalNotificationSession - Throws:
NullArgumentException-signalReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSignalNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSignalNotification()} is {@code true} .
-
getSignalNotificationSessionForMap
SignalNotificationSession getSignalNotificationSessionForMap(SignalReceiver signalReceiver, Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the signal notification service for the given map.- Parameters:
signalReceiver- the notification callbackmapId- theIdof theMapproxy- a proxy- Returns:
- a
SignalNotificationSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-signalReceiver, mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSignalNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSignalNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getSignalMapSession
Gets theOsidSessionto lookup signal/map mappings.- Parameters:
proxy- a proxy- Returns:
- a
SignalMapSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSignalMap()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSignalMap()} is {@code true} .
-
getSignalMapAssignmentSession
SignalMapAssignmentSession getSignalMapAssignmentSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with assigning signals to maps.- Parameters:
proxy- a proxy- Returns:
- a
SignalMapAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSignalMapAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSignalMapAssignment()} is {@code true} .
-
getSignalSmartMapSession
SignalSmartMapSession getSignalSmartMapSession(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage signal smart maps.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- a
SignalSmartMapSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSignalSmartMap()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSignalSmartMap()} is {@code true} .
-
getResourceSignalNotificationSession
ResourceSignalNotificationSession getResourceSignalNotificationSession(ResourceVelocityReceiver resourceSignalReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the resource signal notification service.- Parameters:
resourceSignalReceiver- the notification callbackproxy- a proxy- Returns:
- a
ResourceSignaNotificationSession - Throws:
NullArgumentException-resourceSignalReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsResourceSignaNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsResourceSignaNotification()} is {@code true} .
-
getResourceSignalNotificationSessionForMap
ResourceSignalNotificationSession getResourceSignalNotificationSessionForMap(ResourceVelocityReceiver resourceSignalReceiver, Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the resource signal notification service for the given map.- Parameters:
resourceSignalReceiver- the notification callbackmapId- theIdof theMapproxy- a proxy- Returns:
- a
ResourceSignaNotificationSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-resourceSignalReceiver,mapId, orproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsResourceSignaNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsResourceSignaNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getObstacleLookupSession
Gets theOsidSessionassociated with the obstacle lookup service.- Parameters:
proxy- a proxy- Returns:
- an
ObstacleLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsObstacleLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsObstacleLookup()} is {@code true} .
-
getObstacleLookupSessionForMap
ObstacleLookupSession getObstacleLookupSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the obstacle lookup service for the given map.- Parameters:
mapId- theIdof the mapproxy- a proxy- Returns:
- an
ObstacleLookupSession - Throws:
NotFoundException- noMapfound by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsObstacleLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsObstacleLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getObstacleQuerySession
Gets theOsidSessionassociated with the obstacle query service.- Parameters:
proxy- a proxy- Returns:
- an
ObstacleQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsObstacleQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsObstacleQuery()} is {@code true} .
-
getObstacleQuerySessionForMap
ObstacleQuerySession getObstacleQuerySessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the obstacle query service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- an
ObstacleQuerySession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsObstacleQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsObstacleQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getObstacleSearchSession
Gets theOsidSessionassociated with the obstacle search service.- Parameters:
proxy- a proxy- Returns:
- an
ObstacleSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsObstacleSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsObstacleSearch()} is {@code true} .
-
getObstacleSearchSessionForMap
ObstacleSearchSession getObstacleSearchSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the obstacle search service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- an
ObstacleSearchSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsObstacleSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsObstacleSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getObstacleAdminSession
Gets theOsidSessionassociated with the obstacle administration service.- Parameters:
proxy- a proxy- Returns:
- an
ObstacleAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsObstacleAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsObstacleAdmin()} is {@code true} .
-
getObstacleAdminSessionForMap
ObstacleAdminSession getObstacleAdminSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the obstacle administration service for the given map.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- an
ObstacleAdminSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsObstacleAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsObstacleAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getObstacleNotificationSession
ObstacleNotificationSession getObstacleNotificationSession(ObstacleReceiver obstacleReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the obstacle notification service.- Parameters:
obstacleReceiver- the notification callbackproxy- a proxy- Returns:
- an
ObstacleNotificationSession - Throws:
NullArgumentException-obstacleReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsObstacleNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsObstacleNotification()} is {@code true} .
-
getObstacleNotificationSessionForMap
ObstacleNotificationSession getObstacleNotificationSessionForMap(ObstacleReceiver obstacleReceiver, Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the obstacle notification service for the given map.- Parameters:
obstacleReceiver- the notification callbackmapId- theIdof theMapproxy- a proxy- Returns:
- an
ObstacleNotificationSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-obstacleReceiver, mapId, orproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsObstacleNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsObstacleNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getObstacleMapSession
Gets theOsidSessionto lookup obstacle/map mappings.- Parameters:
proxy- a proxy- Returns:
- an
ObstacleMapSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsObstacleMap()isfalse- Compliance:
optional- This method must be implemented if {@code supportsObstacleMap()} is {@code true} .
-
getObstacleMapAssignmentSession
ObstacleMapAssignmentSession getObstacleMapAssignmentSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with assigning obstacles to maps.- Parameters:
proxy- a proxy- Returns:
- an
ObstacleMapAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsObstacleMapAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsObstacleMapAssignment()} is {@code true} .
-
getObstacleSmartMapSession
ObstacleSmartMapSession getObstacleSmartMapSession(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage locatin smart maps.- Parameters:
mapId- theIdof theMapproxy- a proxy- Returns:
- an
ObstacleSmartMapSession - Throws:
NotFoundException- no map found by the givenIdNullArgumentException-mapId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsObstacleSmartMap()isfalse- Compliance:
optional- This method must be implemented if {@code supportsObstacleSmartMap()} is {@code true} .
-
getMappingPathBatchProxyManager
Gets aMappingPathBatchproxyManager.- Returns:
- a
MappingPathBatchProxyManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsMappingPathBatch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsMappingPathBatch()} is {@code true} .
-
getMappingPathRulesProxyManager
Gets aMappingPathRulesProxyManager.- Returns:
- a
MappingPathRulesProxyManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsMappingPathRules()isfalse- Compliance:
optional- This method must be implemented if {@code supportsMappingPathRules()} is {@code true} .
-