public interface MappingPathManager extends OsidManager, MappingPathProfile
The mapping path manager provides access to path sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
PathLookupSession:
a session to retrieve paths
PathQuerySession:
a session to query for paths
PathSearchSession:
a session to search for paths
PathAdminSession:
a session to create and delete
paths PathNotificationSession:
a session to receive
notifications pertaining to path changes PathMapSession:
a session to looking up mappings
of paths to maps PathMapAssignmentSession:
a session to manage path
to map mappings PathMapAssignmentSession:
a session to manage
dynamic maps of paths PathSpatialSession:
a session to query paths
spatially PathSpatialDesignSession:
a session to spatially
design paths PathTravelSession:
a session to examining a path
for travel ResourcePathNotificationSession:
a session to
subscirbe to resources moving across paths ResourceVelocitySession:
a session to examine
resource velocities ResourceVelocityUpdateSession:
a session to update
resource velocities ResourceVelocityNotificationSession:
a session to
subscribe to changes in resource velocities MyPathSession:
a session to examine paths and
velocities for the authenticated agent. IntersectionLookupSession:
a session to retrieve
intersections IntersectionQuerySession:
a session to query for
intersections IntersectionSearchSession:
a session to search for
intersections IntersectionAdminSession:
a session to create and
delete intersections IntersectionNotificationSession:
a session to
receive notifications pertaining to intersection changes IntersectionMapSession:
a session to looking up
mappings of intersections to maps IntersectionMapAssignmentSession:
a session to
manage intersection to map mappings IntersectionMapAssignmentSession:
a session to
manage dynamic maps of intersections SpeedZoneLookupSession:
a session to retrieve
speed zones SpeedZoneQuerySession:
a session to query for
speed zones SpeedZoneSearchSession:
a session to search for
speed zones SpeedZoneAdminSession:
a session to create and
delete speed zones SpeedZoneNotificationSession:
a session to receive
notifications pertaining to speed zone changes SpeedZoneMapSession:
a session to look up speed
zone to map mappings SpeedZoneMapAssignmentSession:
a session to manage
speed zone to map mappings SpeedZoneSmartMapSession:
a session to manage
dynamic maps of speed zones SignalLookupSession:
a session to retrieve signals
SignalQuerySession:
a session to query for signals
SignalSearchSession:
a session to search for
signals SignalAdminSession:
a session to create and delete
signals SignalNotificationSession:
a session to receive
notifications pertaining to signal changes SignalMapSession:
a session to look up signal to
map mappings SignalMapAssignmentSession:
a session to manage
signal to map mappings SignalSmartMapSession:
a session to manage dynamic
maps of signals ResourceSignalNotificationSession:
a session to
subscribe to signal crossing events ObstacleLookupSession:
a session to retrieve
obstacles ObstacleQuerySession:
a session to query for
obstacles ObstacleSearchSession:
a session to search for
obstacles ObstacleAdminSession:
a session to create and
delete obstacles ObstacleNotificationSession:
a session to receive
notifications pertaining to obstacles changes ObstacleHierarchySession:
a session to examine
obstacles in a hierarchy ObstacleHierarchyAssignmentSession:
a session to
traverse the obstacle hierarchy ObstacleMapSession:
a session to look up obstacle
to map mappings ObstacleMapAssignmentSession:
a session to manage
obstacle to map mappings ObstacleSmartMapSession:
a session to manage
dynamic maps of obstacles Modifier and Type | Method and Description |
---|---|
IntersectionAdminSession |
getIntersectionAdminSession()
Gets the
OsidSession associated with the intersection
administrative service. |
IntersectionAdminSession |
getIntersectionAdminSessionForMap(Id mapId)
Gets the
OsidSession associated with the intersection
administrative service for the given map. |
IntersectionLookupSession |
getIntersectionLookupSession()
Gets the
OsidSession associated with the intersection
lookup service. |
IntersectionLookupSession |
getIntersectionLookupSessionForMap(Id mapId)
Gets the
OsidSession associated with the intersection
lookup service for the given map. |
IntersectionMapAssignmentSession |
getIntersectionMapAssignmentSession()
Gets the
OsidSession associated with assigning
intersections to maps. |
IntersectionMapSession |
getIntersectionMapSession()
Gets the
OsidSession to lookup intersection/map
mappings. |
IntersectionNotificationSession |
getIntersectionNotificationSession(IntersectionReceiver intersectionReceiver)
Gets the
OsidSession associated with the intersection
notification service. |
IntersectionNotificationSession |
getIntersectionNotificationSessionForMap(IntersectionReceiver intersectionReceiver,
Id mapId)
Gets the
OsidSession associated with the intersection
notification service for the given map. |
IntersectionQuerySession |
getIntersectionQuerySession()
Gets the
OsidSession associated with the intersection
query service. |
IntersectionQuerySession |
getIntersectionQuerySessionForMap(Id mapId)
Gets the
OsidSession associated with the intersection
query service for the given map. |
IntersectionSearchSession |
getIntersectionSearchSession()
Gets the
OsidSession associated with the intersection
search service. |
IntersectionSearchSession |
getIntersectionSearchSessionForMap(Id mapId)
Gets the
OsidSession associated with the intersection
search service for the given map. |
IntersectionSmartMapSession |
getIntersectionSmartMapSession(Id mapId)
Gets the
OsidSession to manage intersection smart maps. |
MappingPathBatchManager |
getMappingPathBatchManager()
Gets a
MappingPathBatchManager. |
MappingPathRulesManager |
getMappingPathRulesManager()
Gets a
MappingPathRulesManager. |
MyPathSession |
getMyPathSession()
Gets the
OsidSession associated with the my path
service. |
MyPathSession |
getMyPathSessionForMap(Id mapId)
Gets the
OsidSession associated with the my path
service for the given map. |
ObstacleAdminSession |
getObstacleAdminSession()
Gets the
OsidSession associated with the obstacle
administration service. |
ObstacleAdminSession |
getObstacleAdminSessionForMap(Id mapId)
Gets the
OsidSession associated with the obstacle
administration service for the given map. |
ObstacleLookupSession |
getObstacleLookupSession()
Gets the
OsidSession associated with the obstacle
lookup service. |
ObstacleLookupSession |
getObstacleLookupSessionForMap(Id mapId)
Gets the
OsidSession associated with the obstacle
lookup service for the given map. |
ObstacleMapAssignmentSession |
getObstacleMapAssignmentSession()
Gets the
OsidSession associated with assigning
obstacles to maps. |
ObstacleMapSession |
getObstacleMapSession()
Gets the
OsidSession to lookup obstacle/map mappings. |
ObstacleNotificationSession |
getObstacleNotificationSession(ObstacleReceiver obstacleReceiver)
Gets the
OsidSession associated with the obstacle
notification service. |
ObstacleNotificationSession |
getObstacleNotificationSessionForMap(ObstacleReceiver obstacleReceiver,
Id mapId)
Gets the
OsidSession associated with the obstacle
notification service for the given map. |
ObstacleQuerySession |
getObstacleQuerySession()
Gets the
OsidSession associated with the obstacle query
service. |
ObstacleQuerySession |
getObstacleQuerySessionForMap(Id mapId)
Gets the
OsidSession associated with the obstacle query
service for the given map. |
ObstacleSearchSession |
getObstacleSearchSession()
Gets the
OsidSession associated with the obstacle
search service. |
ObstacleSearchSession |
getObstacleSearchSessionForMap(Id mapId)
Gets the
OsidSession associated with the obstacle
search service for the given map. |
ObstacleSmartMapSession |
getObstacleSmartMapSession(Id mapId)
Gets the
OsidSession to manage locatin smart maps. |
PathAdminSession |
getPathAdminSession()
Gets the
OsidSession associated with the path
administration service. |
PathAdminSession |
getPathAdminSessionForMap(Id mapId)
Gets the
OsidSession associated with the path
administration service for the given map. |
PathLookupSession |
getPathLookupSession()
Gets the
OsidSession associated with the path lookup
service. |
PathLookupSession |
getPathLookupSessionForMap(Id mapId)
Gets the
OsidSession associated with the path lookup
service for the given map. |
PathMapAssignmentSession |
getPathMapAssignmentSession()
Gets the
OsidSession associated with assigning paths to
maps. |
PathMapSession |
getPathMapSession()
Gets the
OsidSession to lookup path/map mappings. |
PathNotificationSession |
getPathNotificationSession(PathReceiver pathReceiver)
Gets the
OsidSession associated with the path
notification service. |
PathNotificationSession |
getPathNotificationSessionForMap(PathReceiver pathReceiver,
Id mapId)
Gets the
OsidSession associated with the path
notification service for the given map. |
PathQuerySession |
getPathQuerySession()
Gets the
OsidSession associated with the path query
service. |
PathQuerySession |
getPathQuerySessionForMap(Id mapId)
Gets the
OsidSession associated with the path query
service for the given map. |
PathSearchSession |
getPathSearchSession()
Gets the
OsidSession associated with the path search
service. |
PathSearchSession |
getPathSearchSessionForMap(Id mapId)
Gets the
OsidSession associated with the path search
service for the given map. |
PathSmartMapSession |
getPathSmartMapSession(Id mapId)
Gets the
OsidSession to manage path smart maps. |
PathSpatialDesignSession |
getPathSpatialDesignSession()
Gets the
OsidSession associated with the path spatial
design service. |
PathSpatialDesignSession |
getPathSpatialDesignSessionForMap(Id mapId)
Gets the
OsidSession associated with the path spatial
design service for the given map. |
PathSpatialSession |
getPathSpatialSession()
Gets the
OsidSession associated with the path spatial
service. |
PathSpatialSession |
getPathSpatialSessionForMap(Id mapId)
Gets the
OsidSession associated with the path spatial
service for the given map. |
PathTravelSession |
getPathTravelSession()
Gets the
OsidSession associated with the path travel
service. |
PathTravelSession |
getPathTravelSessionForMap(Id mapId)
Gets the
OsidSession associated with the path travel
service for the given map. |
ResourcePathNotificationSession |
getResourcePathNotificationSession(ResourcePathReceiver resourcePathReceiver)
Gets the
OsidSession associated with the resource path
notification service. |
ResourcePathNotificationSession |
getResourcePathNotificationSessionForMap(ResourcePathReceiver resourcePathReceiver,
Id mapId)
Gets the
OsidSession associated with the resource path
notification service for the given map. |
ResourceSignalNotificationSession |
getResourceSignalNotificationSession(ResourceVelocityReceiver resourceSignaReceiver)
Gets the
OsidSession associated with the resource
signal notification service. |
ResourceSignalNotificationSession |
getResourceSignaNotificationSessionForMap(ResourceVelocityReceiver resourceSignaReceiver,
Id mapId)
Gets the
OsidSession associated with the resource
signal notification service for the given map. |
ResourceVelocityNotificationSession |
getResourceVelocityNotificationSession(ResourceVelocityReceiver resourceVelocityReceiver)
Gets the
OsidSession associated with the resource
velocity notification service. |
ResourceVelocityNotificationSession |
getResourceVelocityNotificationSessionForMap(ResourceVelocityReceiver resourceVelocityReceiver,
Id mapId)
Gets the
OsidSession associated with the resource
velocity notification service for the given map. |
ResourceVelocitySession |
getResourceVelocitySession()
Gets the
OsidSession associated with the resource
velocity service. |
ResourceVelocitySession |
getResourceVelocitySessionForMap(Id mapId)
Gets the
OsidSession associated with the resource
velocity service for the given map. |
ResourceVelocityUpdateSession |
getResourceVelocityUpdateSession()
Gets the
OsidSession associated with the resource
velocity update service. |
ResourceVelocityUpdateSession |
getResourceVelocityUpdateSessionForMap(Id mapId)
Gets the
OsidSession associated with the resource
velocity update service for the given map. |
SignalAdminSession |
getSignalAdminSession()
Gets the
OsidSession associated with the signal
administration service. |
SignalAdminSession |
getSignalAdminSessionForMap(Id mapId)
Gets the
OsidSession associated with the signal
administration service for the given map. |
SignalLookupSession |
getSignalLookupSession()
Gets the
OsidSession associated with the signal lookup
service. |
SignalLookupSession |
getSignalLookupSessionForMap(Id mapId)
Gets the
OsidSession associated with the signal lookup
service for the given map. |
SignalMapAssignmentSession |
getSignalMapAssignmentSession()
Gets the
OsidSession associated with assigning signals
to maps. |
SignalMapSession |
getSignalMapSession()
Gets the
OsidSession to lookup signal/map mappings. |
SignalNotificationSession |
getSignalNotificationSession(SignalReceiver signalReceiver)
Gets the
OsidSession associated with the signal
notification service. |
SignalNotificationSession |
getSignalNotificationSessionForMap(SignalReceiver signalReceiver,
Id mapId)
Gets the
OsidSession associated with the signal
notification service for the given map. |
SignalQuerySession |
getSignalQuerySession()
Gets the
OsidSession associated with the signal query
service. |
SignalQuerySession |
getSignalQuerySessionForMap(Id mapId)
Gets the
OsidSession associated with the signal query
service for the given map. |
SignalSearchSession |
getSignalSearchSession()
Gets the
OsidSession associated with the signal search
service. |
SignalSearchSession |
getSignalSearchSessionForMap(Id mapId)
Gets the
OsidSession associated with the signal search
service for the given map. |
SignalSmartMapSession |
getSignalSmartMapSession(Id mapId)
Gets the
OsidSession to manage locatin smart maps. |
SpeedZoneAdminSession |
getSpeedZoneAdminSession()
Gets the
OsidSession associated with the speed zone
administration service. |
SpeedZoneAdminSession |
getSpeedZoneAdminSessionForMap(Id mapId)
Gets the
OsidSession associated with the speed zone
administration service for the given map. |
SpeedZoneLookupSession |
getSpeedZoneLookupSession()
Gets the
OsidSession associated with the speed zone
lookup service. |
SpeedZoneLookupSession |
getSpeedZoneLookupSessionForMap(Id mapId)
Gets the
OsidSession associated with the speed zone
lookup service for the given map. |
SpeedZoneMapAssignmentSession |
getSpeedZoneMapAssignmentSession()
Gets the
OsidSession associated with assigning speed
zones to maps. |
SpeedZoneMapSession |
getSpeedZoneMapSession()
Gets the
OsidSession to lookup speed zone/map mappings. |
SpeedZoneNotificationSession |
getSpeedZoneNotificationSession(SpeedZoneReceiver speedZoneReceiver)
Gets the
OsidSession associated with the speed zone
notification service. |
SpeedZoneNotificationSession |
getSpeedZoneNotificationSessionForMap(SpeedZoneReceiver speedZoneReceiver,
Id mapId)
Gets the
OsidSession associated with the speed zone
notification service for the given map. |
SpeedZoneQuerySession |
getSpeedZoneQuerySession()
Gets the
OsidSession associated with the speed zone
query service. |
SpeedZoneQuerySession |
getSpeedZoneQuerySessionForMap(Id mapId)
Gets the
OsidSession associated with the speed zone
query service for the given map. |
SpeedZoneSearchSession |
getSpeedZoneSearchSession()
Gets the
OsidSession associated with the speed zone
search service. |
SpeedZoneSearchSession |
getSpeedZoneSearchSessionForMap(Id mapId)
Gets the
OsidSession associated with the speed zone
search service for the given map. |
SpeedZoneSmartMapSession |
getSpeedZoneSmartMapSession(Id mapId)
Gets the
OsidSession to manage locatin smart maps. |
changeBranch, initialize, rollbackService
close
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, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
PathLookupSession getPathLookupSession() throws OperationFailedException
OsidSession
associated with the path lookup
service. PathLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPathLookup()
is false
optional
- This method must be implemented if
supportsPathLookup()
is true.
PathLookupSession getPathLookupSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the path lookup
service for the given map.mapId
- the Id
of the Map
PathLookupSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPathLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPathLookup()
and
supportsVisibleFederation()
are true
PathQuerySession getPathQuerySession() throws OperationFailedException
OsidSession
associated with the path query
service. PathQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPathQuery()
is false
optional
- This method must be implemented if
supportsPathQuery()
is true.
PathQuerySession getPathQuerySessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the path query
service for the given map.mapId
- the Id
of the Map
PathQuerySession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPathQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPathQuery()
and
supportsVisibleFederation()
are true
PathSearchSession getPathSearchSession() throws OperationFailedException
OsidSession
associated with the path search
service. PathSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPathSearch()
is false
optional
- This method must be implemented if
supportsPathSearch()
is true.
PathSearchSession getPathSearchSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the path search
service for the given map.mapId
- the Id
of the Map
PathSearchSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPathSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPathSearch()
and
supportsVisibleFederation()
are true
PathAdminSession getPathAdminSession() throws OperationFailedException
OsidSession
associated with the path
administration service. PathAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPathAdmin()
is false
optional
- This method must be implemented if
supportsPathAdmin()
is true.
PathAdminSession getPathAdminSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the path
administration service for the given map.mapId
- the Id
of the Map
PathAdminSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPathAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPathAdmin()
and
supportsVisibleFederation()
are true
PathNotificationSession getPathNotificationSession(PathReceiver pathReceiver) throws OperationFailedException
OsidSession
associated with the path
notification service.pathReceiver
- the notification callback PathNotificationSession
NullArgumentException
- pathReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPathNotification()
is false
optional
- This method must be implemented if
supportsPathNotification()
is true.
PathNotificationSession getPathNotificationSessionForMap(PathReceiver pathReceiver, Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the path
notification service for the given map.pathReceiver
- the notification callbackmapId
- the Id
of the Map
PathNotificationSession
NotFoundException
- no map found by the given Id
NullArgumentException
- pathReceiver
or
mapId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPathNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPathNotification()
and
supportsVisibleFederation()
are true
PathMapSession getPathMapSession() throws OperationFailedException
OsidSession
to lookup path/map mappings. PathMapSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPathMap()
is false
optional
- This method must be implemented if
supportsPathMap()
is true.
PathMapAssignmentSession getPathMapAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning paths to
maps. PathMapAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPathMapAssignment()
is false
optional
- This method must be implemented if
supportsPathMapAssignment()
is true.
PathSmartMapSession getPathSmartMapSession(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
to manage path smart maps.mapId
- the Id
of the Map
PathSmartMapSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPathSmartMap()
is false
optional
- This method must be implemented if
supportsPathSmartMap()
is true.
PathSpatialSession getPathSpatialSession() throws OperationFailedException
OsidSession
associated with the path spatial
service. PathSpatialSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPathSpatial()
is false
optional
- This method must be implemented if
supportsPathSpatial()
is true.
PathSpatialSession getPathSpatialSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the path spatial
service for the given map.mapId
- the Id
of the Map
PathSpatialSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPathSpatial()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPathSpatial()
and
supportsVisibleFederation()
are true
PathSpatialDesignSession getPathSpatialDesignSession() throws OperationFailedException
OsidSession
associated with the path spatial
design service. PathSpatialDesignSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPathSpatialDesign()
is false
optional
- This method must be implemented if
supportsPathSpatialDesign()
is true.
PathSpatialDesignSession getPathSpatialDesignSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the path spatial
design service for the given map.mapId
- the Id
of the Map
PathSpatialDesignSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsPathSpatialDesign()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsPathSpatialDesign()
and
supportsVisibleFederation()
are true
PathTravelSession getPathTravelSession() throws OperationFailedException
OsidSession
associated with the path travel
service. PathTravelSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPathTravel()
is false
optional
- This method must be implemented if
supportsPathTravel()
is true.
PathTravelSession getPathTravelSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the path travel
service for the given map.mapId
- the Id
of the Map
PathTravelSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsPathTravel()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsPathTravel()
and
supportsVisibleFederation()
are true
ResourcePathNotificationSession getResourcePathNotificationSession(ResourcePathReceiver resourcePathReceiver) throws OperationFailedException
OsidSession
associated with the resource path
notification service.resourcePathReceiver
- the notification callback ResourcePathNotificationSession
NullArgumentException
- resourcePathReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourcePathNotification()
is false
optional
- This method must be implemented if
supportsResourcePathNotification()
is true.
ResourcePathNotificationSession getResourcePathNotificationSessionForMap(ResourcePathReceiver resourcePathReceiver, Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the resource path
notification service for the given map.resourcePathReceiver
- the notification callbackmapId
- the Id
of the Map
ResourcePathNotificationSession
NotFoundException
- no map found by the given Id
NullArgumentException
- resourcePathReceiver
or mapId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourcePathNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsResourcePathNotification()
and
supportsVisibleFederation()
are true
ResourceVelocitySession getResourceVelocitySession() throws OperationFailedException
OsidSession
associated with the resource
velocity service. ResourceVelocitySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourceVelocity()
is false
optional
- This method must be implemented if
supportsResourceVelocity()
is true.
ResourceVelocitySession getResourceVelocitySessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the resource
velocity service for the given map.mapId
- the Id
of the Map
ResourceVelocitySession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourceVelocity()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsResourceVelocity()
and
supportsVisibleFederation()
are true
ResourceVelocityUpdateSession getResourceVelocityUpdateSession() throws OperationFailedException
OsidSession
associated with the resource
velocity update service. ResourceVelocityUpdateSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourceVelocityUpdate()
is false
optional
- This method must be implemented if
supportsResourceVelocityUpdate()
is true.
ResourceVelocityUpdateSession getResourceVelocityUpdateSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the resource
velocity update service for the given map.mapId
- the Id
of the Map
ResourceVelocityUpdateSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourceVelocityUpdate()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsResourceVelocityUpdate()
and
supportsVisibleFederation()
are true
ResourceVelocityNotificationSession getResourceVelocityNotificationSession(ResourceVelocityReceiver resourceVelocityReceiver) throws OperationFailedException
OsidSession
associated with the resource
velocity notification service.resourceVelocityReceiver
- the notification callback ResourceVelocityNotificationSession
NullArgumentException
- resourceVelocityReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourceVelocityNotification()
is false
optional
- This method must be implemented if
supportsResourceVelocityNotification()
is
true.
ResourceVelocityNotificationSession getResourceVelocityNotificationSessionForMap(ResourceVelocityReceiver resourceVelocityReceiver, Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the resource
velocity notification service for the given map.resourceVelocityReceiver
- the notification callbackmapId
- the Id
of the Map
ResourceVelocityNotificationSession
NotFoundException
- no map found by the given Id
NullArgumentException
- resourceVelocityReceiver
or mapId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourceVelocityNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsResourceVelocityNotification()
and
supportsVisibleFederation()
are true
MyPathSession getMyPathSession() throws OperationFailedException
OsidSession
associated with the my path
service. MyPathSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMyPath()
is false
optional
- This method must be implemented if
supportsMyPath()
is true.
MyPathSession getMyPathSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the my path
service for the given map.mapId
- the Id
of the Map
MyPathSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMyPath()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMyPath()
and
supportsVisibleFederation()
are true
IntersectionLookupSession getIntersectionLookupSession() throws OperationFailedException
OsidSession
associated with the intersection
lookup service. IntersectionLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIntersectionLookup()
is false
optional
- This method must be implemented if
supportsIntersectionLookup()
is true.
IntersectionLookupSession getIntersectionLookupSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the intersection
lookup service for the given map.mapId
- the Id
of the Map
IntersectionLookupSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIntersectionLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsIntersectionLookup()
and
supportsVisibleFederation()
are true
IntersectionQuerySession getIntersectionQuerySession() throws OperationFailedException
OsidSession
associated with the intersection
query service. IntersectionQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIntersectionQuery()
is false
optional
- This method must be implemented if
supportsIntersectionQuery()
is true.
IntersectionQuerySession getIntersectionQuerySessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the intersection
query service for the given map.mapId
- the Id
of the Map
IntersectionQuerySession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIntersectionQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsIntersectionQuery()
and
supportsVisibleFederation()
are true
IntersectionSearchSession getIntersectionSearchSession() throws OperationFailedException
OsidSession
associated with the intersection
search service. IntersectionSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIntersectionSearch()
is false
optional
- This method must be implemented if
supportsIntersectionSearch()
is true.
IntersectionSearchSession getIntersectionSearchSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the intersection
search service for the given map.mapId
- the Id
of the Map
IntersectionSearchSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIntersectionSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsIntersectionSearch()
and
supportsVisibleFederation()
are true
IntersectionAdminSession getIntersectionAdminSession() throws OperationFailedException
OsidSession
associated with the intersection
administrative service. IntersectionAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIntersectionAdmin()
is false
optional
- This method must be implemented if
supportsIntersectionAdmin()
is true.
IntersectionAdminSession getIntersectionAdminSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the intersection
administrative service for the given map.mapId
- the Id
of the Map
IntersectionAdminSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIntersectionAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsIntersectionAdmin()
and
supportsVisibleFederation()
are true
IntersectionNotificationSession getIntersectionNotificationSession(IntersectionReceiver intersectionReceiver) throws OperationFailedException
OsidSession
associated with the intersection
notification service.intersectionReceiver
- the notification callback IntersectionNotificationSession
NullArgumentException
- intersectionReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIntersectionNotification()
is false
optional
- This method must be implemented if
supportsIntersectionNotification()
is true.
IntersectionNotificationSession getIntersectionNotificationSessionForMap(IntersectionReceiver intersectionReceiver, Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the intersection
notification service for the given map.intersectionReceiver
- the notification callbackmapId
- the Id
of the Map
IntersectionNotificationSession
NotFoundException
- no map found by the given Id
NullArgumentException
- intersectionReceiver
or mapId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIntersectionNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsIntersectionNotification()
and
supportsVisibleFederation()
are true
IntersectionMapSession getIntersectionMapSession() throws OperationFailedException
OsidSession
to lookup intersection/map
mappings. IntersectionMapSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIntersectionMap()
is false
optional
- This method must be implemented if
supportsIntersectionMap()
is true.
IntersectionMapAssignmentSession getIntersectionMapAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
intersections to maps. IntersectionMapAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIntersectionMapAssignment()
is false
optional
- This method must be implemented if
supportsIntersectionMapAssignment()
is
true.
IntersectionSmartMapSession getIntersectionSmartMapSession(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
to manage intersection smart maps.mapId
- the Id
of the Map
IntersectionSmartMapSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIntersectionSmartMap()
is false
optional
- This method must be implemented if
supportsIntersectionSmartMap()
is true.
SpeedZoneLookupSession getSpeedZoneLookupSession() throws OperationFailedException
OsidSession
associated with the speed zone
lookup service. SpeedZoneLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSpeedZoneLookup()
is false
optional
- This method must be implemented if
supportsSpeedZoneLookup()
is true.
SpeedZoneLookupSession getSpeedZoneLookupSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the speed zone
lookup service for the given map.mapId
- the Id
of the map SpeedZoneLookupSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSpeedZoneLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSpeedZoneLookup()
and
supportsVisibleFederation()
are true
SpeedZoneQuerySession getSpeedZoneQuerySession() throws OperationFailedException
OsidSession
associated with the speed zone
query service. SpeedZoneQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSpeedZoneQuery()
is false
optional
- This method must be implemented if
supportsSpeedZoneQuery()
is true.
SpeedZoneQuerySession getSpeedZoneQuerySessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the speed zone
query service for the given map.mapId
- the Id
of the Map
SpeedZoneQuerySession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSpeedZoneQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSpeedZoneQuery()
and
supportsVisibleFederation()
are true
SpeedZoneSearchSession getSpeedZoneSearchSession() throws OperationFailedException
OsidSession
associated with the speed zone
search service. SpeedZoneSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSpeedZoneSearch()
is false
optional
- This method must be implemented if
supportsSpeedZoneSearch()
is true.
SpeedZoneSearchSession getSpeedZoneSearchSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the speed zone
search service for the given map.mapId
- the Id
of the Map
SpeedZoneSearchSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSpeedZoneSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSpeedZoneSearch()
and
supportsVisibleFederation()
are true
SpeedZoneAdminSession getSpeedZoneAdminSession() throws OperationFailedException
OsidSession
associated with the speed zone
administration service. SpeedZoneAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSpeedZoneAdmin()
is false
optional
- This method must be implemented if
supportsSpeedZoneAdmin()
is true.
SpeedZoneAdminSession getSpeedZoneAdminSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the speed zone
administration service for the given map.mapId
- the Id
of the Map
SpeedZoneAdminSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSpeedZoneAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSpeedZoneAdmin()
and
supportsVisibleFederation()
are true
SpeedZoneNotificationSession getSpeedZoneNotificationSession(SpeedZoneReceiver speedZoneReceiver) throws OperationFailedException
OsidSession
associated with the speed zone
notification service.speedZoneReceiver
- the notification callback SpeedZoneNotificationSession
NullArgumentException
- speedZoneReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSpeedZoneNotification()
is false
optional
- This method must be implemented if
supportsSpeedZoneNotification()
is true.
SpeedZoneNotificationSession getSpeedZoneNotificationSessionForMap(SpeedZoneReceiver speedZoneReceiver, Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the speed zone
notification service for the given map.speedZoneReceiver
- the notification callbackmapId
- the Id
of the Map
SpeedZoneNotificationSession
NotFoundException
- no map found by the given Id
NullArgumentException
- speedZoneReceiver
or mapId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSpeedZoneNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSpeedZoneNotification()
and
supportsVisibleFederation()
are true
SpeedZoneMapSession getSpeedZoneMapSession() throws OperationFailedException
OsidSession
to lookup speed zone/map mappings. SpeedZoneMapSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSpeedZoneMap()
is false
optional
- This method must be implemented if
supportsSpeedZoneMap()
is true.
SpeedZoneMapAssignmentSession getSpeedZoneMapAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning speed
zones to maps. SpeedZoneMapAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSpeedZoneMapAssignment()
is false
optional
- This method must be implemented if
supportsSpeedZoneMapAssignment()
is true.
SpeedZoneSmartMapSession getSpeedZoneSmartMapSession(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
to manage locatin smart maps.mapId
- the Id
of the Map
SpeedZoneSmartMapSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSpeedZoneSmartMap()
is false
optional
- This method must be implemented if
supportsSpeedZoneSmartMap()
is true.
SignalLookupSession getSignalLookupSession() throws OperationFailedException
OsidSession
associated with the signal lookup
service. SignalLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSignalLookup()
is false
optional
- This method must be implemented if
supportsSignalLookup()
is true.
SignalLookupSession getSignalLookupSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the signal lookup
service for the given map.mapId
- the Id
of the map SignalLookupSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSignalLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsSignalLookup()
and
supportsVisibleFederation()
are true
SignalQuerySession getSignalQuerySession() throws OperationFailedException
OsidSession
associated with the signal query
service. SignalQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSignalQuery()
is false
optional
- This method must be implemented if
supportsSignalQuery()
is true.
SignalQuerySession getSignalQuerySessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the signal query
service for the given map.mapId
- the Id
of the Map
SignalQuerySession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSignalQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsSignalQuery()
and
supportsVisibleFederation()
are true
SignalSearchSession getSignalSearchSession() throws OperationFailedException
OsidSession
associated with the signal search
service. SignalSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSignalSearch()
is false
optional
- This method must be implemented if
supportsSignalSearch()
is true.
SignalSearchSession getSignalSearchSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the signal search
service for the given map.mapId
- the Id
of the Map
SignalSearchSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSignalSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsSignalSearch()
and
supportsVisibleFederation()
are true
SignalAdminSession getSignalAdminSession() throws OperationFailedException
OsidSession
associated with the signal
administration service. SignalAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSignalAdmin()
is false
optional
- This method must be implemented if
supportsSignalAdmin()
is true.
SignalAdminSession getSignalAdminSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the signal
administration service for the given map.mapId
- the Id
of the Map
SignalAdminSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSignalAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsSignalAdmin()
and
supportsVisibleFederation()
are true
SignalNotificationSession getSignalNotificationSession(SignalReceiver signalReceiver) throws OperationFailedException
OsidSession
associated with the signal
notification service.signalReceiver
- the notification callback SignalNotificationSession
NullArgumentException
- signalReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSignalNotification()
is false
optional
- This method must be implemented if
supportsSignalNotification()
is true.
SignalNotificationSession getSignalNotificationSessionForMap(SignalReceiver signalReceiver, Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the signal
notification service for the given map.signalReceiver
- the notification callbackmapId
- the Id
of the Map
SignalNotificationSession
NotFoundException
- no map found by the given Id
NullArgumentException
- signalReceiver
or mapId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSignalNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsSignalNotification()
and
supportsVisibleFederation()
are true
SignalMapSession getSignalMapSession() throws OperationFailedException
OsidSession
to lookup signal/map mappings. SignalMapSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsSignalMap()
is false
optional
- This method must be implemented if
supportsSignalMap()
is true.
SignalMapAssignmentSession getSignalMapAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning signals
to maps. SignalMapAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSignalMapAssignment()
is false
optional
- This method must be implemented if
supportsSignalMapAssignment()
is true.
SignalSmartMapSession getSignalSmartMapSession(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
to manage locatin smart maps.mapId
- the Id
of the Map
SignalSmartMapSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsSignalSmartMap()
is false
optional
- This method must be implemented if
supportsSignalSmartMap()
is true.
ResourceSignalNotificationSession getResourceSignalNotificationSession(ResourceVelocityReceiver resourceSignaReceiver) throws OperationFailedException
OsidSession
associated with the resource
signal notification service.resourceSignaReceiver
- the notification callback ResourceSignaNotificationSession
NullArgumentException
- resourceSignaReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourceSignaNotification()
is false
optional
- This method must be implemented if
supportsResourceSignaNotification()
is
true.
ResourceSignalNotificationSession getResourceSignaNotificationSessionForMap(ResourceVelocityReceiver resourceSignaReceiver, Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the resource
signal notification service for the given map.resourceSignaReceiver
- the notification callbackmapId
- the Id
of the Map
ResourceSignaNotificationSession
NotFoundException
- no map found by the given Id
NullArgumentException
- resourceSignaReceiver
or mapId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourceSignaNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsResourceSignaNotification()
and
supportsVisibleFederation()
are true
ObstacleLookupSession getObstacleLookupSession() throws OperationFailedException
OsidSession
associated with the obstacle
lookup service. ObstacleLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsObstacleLookup()
is false
optional
- This method must be implemented if
supportsObstacleLookup()
is true.
ObstacleLookupSession getObstacleLookupSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the obstacle
lookup service for the given map.mapId
- the Id
of the map ObstacleLookupSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsObstacleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsObstacleLookup()
and
supportsVisibleFederation()
are true
ObstacleQuerySession getObstacleQuerySession() throws OperationFailedException
OsidSession
associated with the obstacle query
service. ObstacleQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsObstacleQuery()
is false
optional
- This method must be implemented if
supportsObstacleQuery()
is true.
ObstacleQuerySession getObstacleQuerySessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the obstacle query
service for the given map.mapId
- the Id
of the Map
ObstacleQuerySession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsObstacleQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsObstacleQuery()
and
supportsVisibleFederation()
are true
ObstacleSearchSession getObstacleSearchSession() throws OperationFailedException
OsidSession
associated with the obstacle
search service. ObstacleSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsObstacleSearch()
is false
optional
- This method must be implemented if
supportsObstacleSearch()
is true.
ObstacleSearchSession getObstacleSearchSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the obstacle
search service for the given map.mapId
- the Id
of the Map
ObstacleSearchSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsObstacleSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsObstacleSearch()
and
supportsVisibleFederation()
are true
ObstacleAdminSession getObstacleAdminSession() throws OperationFailedException
OsidSession
associated with the obstacle
administration service. ObstacleAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsObstacleAdmin()
is false
optional
- This method must be implemented if
supportsObstacleAdmin()
is true.
ObstacleAdminSession getObstacleAdminSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the obstacle
administration service for the given map.mapId
- the Id
of the Map
ObstacleAdminSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsObstacleAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsObstacleAdmin()
and
supportsVisibleFederation()
are true
ObstacleNotificationSession getObstacleNotificationSession(ObstacleReceiver obstacleReceiver) throws OperationFailedException
OsidSession
associated with the obstacle
notification service.obstacleReceiver
- the notification callback ObstacleNotificationSession
NullArgumentException
- obstacleReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsObstacleNotification()
is false
optional
- This method must be implemented if
supportsObstacleNotification()
is true.
ObstacleNotificationSession getObstacleNotificationSessionForMap(ObstacleReceiver obstacleReceiver, Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the obstacle
notification service for the given map.obstacleReceiver
- the notification callbackmapId
- the Id
of the Map
ObstacleNotificationSession
NotFoundException
- no map found by the given Id
NullArgumentException
- obstacleReceiver
or mapId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsObstacleNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsObstacleNotification()
and
supportsVisibleFederation()
are true
ObstacleMapSession getObstacleMapSession() throws OperationFailedException
OsidSession
to lookup obstacle/map mappings. ObstacleMapSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsObstacleMap()
is false
optional
- This method must be implemented if
supportsObstacleMap()
is true.
ObstacleMapAssignmentSession getObstacleMapAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
obstacles to maps. ObstacleMapAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsObstacleMapAssignment()
is false
optional
- This method must be implemented if
supportsObstacleMapAssignment()
is true.
ObstacleSmartMapSession getObstacleSmartMapSession(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
to manage locatin smart maps.mapId
- the Id
of the Map
ObstacleSmartMapSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsObstacleSmartMap()
is false
optional
- This method must be implemented if
supportsObstacleSmartMap()
is true.
MappingPathBatchManager getMappingPathBatchManager() throws OperationFailedException
MappingPathBatchManager.
MappingPathBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMappingPathBatch()
is false
optional
- This method must be implemented if
supportsMappingPathBatch()
is true.
MappingPathRulesManager getMappingPathRulesManager() throws OperationFailedException
MappingPathRulesManager.
MappingPathRulesManager
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsMappingPathRules()
is false
optional
- This method must be implemented if
supportsMappingPathRules()
is true.