Interface MappingPathManager

All Superinterfaces:

AutoCloseable, Closeable, MappingPathProfile, OsidManager, OsidManager, OsidProfile, Sourceable

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

Method Summary

Modifier and Type	Method	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 resourceSignalReceiver)	Gets the OsidSession associated with the resource signal notification service.
ResourceSignalNotificationSession	getResourceSignalNotificationSessionForMap(ResourceVelocityReceiver resourceSignalReceiver, 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.

Methods inherited from interface Closeable

close

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, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getIntersectionRecordTypes()	Gets the supported Intersection record types.
TypeList	getIntersectionSearchRecordTypes()	Gets the supported Intersection search record types.
TypeList	getObstacleRecordTypes()	Gets the supported Obstacle record types.
TypeList	getObstacleSearchRecordTypes()	Gets the supported Obstacle search types.
TypeList	getPathRecordTypes()	Gets the supported Path record types.
TypeList	getPathSearchRecordTypes()	Gets the supported Path search record types.
TypeList	getResourceVelocityRecordTypes()	Gets the supported ResourceVelocity record types.
TypeList	getSignalRecordTypes()	Gets the supported Signal record types.
TypeList	getSignalSearchRecordTypes()	Gets the supported Signal search types.
TypeList	getSpeedZoneRecordTypes()	Gets the supported SpeedZone record types.
TypeList	getSpeedZoneSearchRecordTypes()	Gets the supported SpeedZone search types.
boolean	supportsIntersectionAdmin()	Tests if an intersection administrative service is supported.
boolean	supportsIntersectionLookup()	Tests if an intersection lookup service is supported.
boolean	supportsIntersectionMap()	Tests if an intersection map lookup service is supported.
boolean	supportsIntersectionMapAssignment()	Tests if an intersection map service is supported.
boolean	supportsIntersectionNotification()	Tests if an intersection notification service is supported.
boolean	supportsIntersectionQuery()	Tests if querying intersections is supported.
boolean	supportsIntersectionRecordType(Type intersectionRecordType)	Tests if the given Intersection record type is supported.
boolean	supportsIntersectionSearch()	Tests if searching intersections is supported.
boolean	supportsIntersectionSearchRecordType(Type intersectionSearchRecordType)	Tests if the given Intersection search record type is supported.
boolean	supportsIntersectionSmartMap()	Tests if an intersection smart map lookup service is supported.
boolean	supportsMappingPathBatch()	Tests if a batch mapping path service is supported.
boolean	supportsMappingPathRules()	Tests if a mapping path rules service is supported.
boolean	supportsMyPath()	Tests if a my path service is supported.
boolean	supportsObstacleAdmin()	Tests if obstacle administrative service is supported.
boolean	supportsObstacleHierarchy()	Tests if an obstacle hierarchy service is supported.
boolean	supportsObstacleHierarchyDesign()	Tests if an obstacle hierarchy design service is supported.
boolean	supportsObstacleLookup()	Tests if looking up obstacles is supported.
boolean	supportsObstacleMap()	Tests if an obstacle map lookup service is supported.
boolean	supportsObstacleMapAssignment()	Tests if an obstacle map assignment service is supported.
boolean	supportsObstacleNotification()	Tests if an obstacle notification service is supported.
boolean	supportsObstacleQuery()	Tests if querying obstacles is supported.
boolean	supportsObstacleRecordType(Type obstacleRecordType)	Tests if the given Obstacle record type is supported.
boolean	supportsObstacleSearch()	Tests if searching obstacles is supported.
boolean	supportsObstacleSearchRecordType(Type obstacleSearchRecordType)	Tests if the given Obstacle search type is supported.
boolean	supportsObstacleSmartMap()	Tests if an obstacle smart map service is supported.
boolean	supportsPathAdmin()	Tests if path administrative service is supported.
boolean	supportsPathLookup()	Tests if looking up paths is supported.
boolean	supportsPathMap()	Tests if a path map lookup service is supported.
boolean	supportsPathMapAssignment()	Tests if a path map service is supported.
boolean	supportsPathNotification()	Tests if a path notification service is supported.
boolean	supportsPathQuery()	Tests if querying paths is supported.
boolean	supportsPathRecordType(Type pathRecordType)	Tests if the given Path record type is supported.
boolean	supportsPathSearch()	Tests if searching paths is supported.
boolean	supportsPathSearchRecordType(Type pathSearchRecordType)	Tests if the given Path search record type is supported.
boolean	supportsPathSmartMap()	Tests if a path smart map lookup service is supported.
boolean	supportsPathSpatial()	Tests if a path spatial lookup service is supported.
boolean	supportsPathSpatialDesign()	Tests if a path spatial design service is supported.
boolean	supportsPathTravel()	Tests if a path travel service is supported.
boolean	supportsResourcePathNotification()	Tests if a resource path notification service is supported.
boolean	supportsResourceSignalNotification()	Tests if a resource signal notification service is supported.
boolean	supportsResourceVelocity()	Tests if a resource velocity service is supported.
boolean	supportsResourceVelocityNotification()	Tests if a resource velocity notification service is supported.
boolean	supportsResourceVelocityRecordType(Type resourceVelocityRecordType)	Tests if the given ResourceVelocity record type is supported.
boolean	supportsResourceVelocityUpdate()	Tests if a resource velocity update service is supported.
boolean	supportsSignalAdmin()	Tests if signal administrative service is supported.
boolean	supportsSignalLookup()	Tests if looking up signals is supported.
boolean	supportsSignalMap()	Tests if a signal map lookup service is supported.
boolean	supportsSignalMapAssignment()	Tests if a signal map assignment service is supported.
boolean	supportsSignalNotification()	Tests if a signal notification service is supported.
boolean	supportsSignalQuery()	Tests if querying signals is supported.
boolean	supportsSignalRecordType(Type signalRecordType)	Tests if the given Signal record type is supported.
boolean	supportsSignalSearch()	Tests if searching signals is supported.
boolean	supportsSignalSearchRecordType(Type signalSearchRecordType)	Tests if the given Signal search type is supported.
boolean	supportsSignalSmartMap()	Tests if a signal smart map service is supported.
boolean	supportsSpeedZoneAdmin()	Tests if speed zone administrative service is supported.
boolean	supportsSpeedZoneLookup()	Tests if looking up speed zones is supported.
boolean	supportsSpeedZoneMap()	Tests if a speed zone map lookup service is supported.
boolean	supportsSpeedZoneMapAssignment()	Tests if a speed zone map assignment service is supported.
boolean	supportsSpeedZoneNotification()	Tests if a speed zone notification service is supported.
boolean	supportsSpeedZoneQuery()	Tests if querying speed zones is supported.
boolean	supportsSpeedZoneRecordType(Type speedZoneRecordType)	Tests if the given SpeedZone record type is supported.
boolean	supportsSpeedZoneSearch()	Tests if searching speed zones is supported.
boolean	supportsSpeedZoneSearchRecordType(Type speedZoneSearchRecordType)	Tests if the given SpeedZone search type is supported.
boolean	supportsSpeedZoneSmartMap()	Tests if a speed zone smart map service is supported.
boolean	supportsVisibleFederation()	Tests if any map federation is exposed.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getPathLookupSession

PathLookupSession getPathLookupSession()
                                throws OperationFailedException

Gets the OsidSession associated with the path lookup service.

Returns:

a PathLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsPathLookup()} is {@code true} .

getPathLookupSessionForMap

PathLookupSession getPathLookupSessionForMap(Id mapId)
                                      throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a PathLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPathLookup()} and {@code supportsVisibleFederation()} are {@code true}

getPathQuerySession

PathQuerySession getPathQuerySession()
                              throws OperationFailedException

Gets the OsidSession associated with the path query service.

Returns:

a PathQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsPathQuery()} is {@code true} .

getPathQuerySessionForMap

PathQuerySession getPathQuerySessionForMap(Id mapId)
                                    throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a PathQuerySession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPathQuery()} and {@code supportsVisibleFederation()} are {@code true}

getPathSearchSession

PathSearchSession getPathSearchSession()
                                throws OperationFailedException

Gets the OsidSession associated with the path search service.

Returns:

a PathSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsPathSearch()} is {@code true} .

getPathSearchSessionForMap

PathSearchSession getPathSearchSessionForMap(Id mapId)
                                      throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a PathSearchSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPathSearch()} and {@code supportsVisibleFederation()} are {@code true}

getPathAdminSession

PathAdminSession getPathAdminSession()
                              throws OperationFailedException

Gets the OsidSession associated with the path administration service.

Returns:

a PathAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsPathAdmin()} is {@code true} .

getPathAdminSessionForMap

PathAdminSession getPathAdminSessionForMap(Id mapId)
                                    throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a PathAdminSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPathAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getPathNotificationSession

PathNotificationSession getPathNotificationSession(PathReceiver pathReceiver)
                                            throws OperationFailedException

Gets the OsidSession associated with the path notification service.

Parameters:

pathReceiver - the notification callback

Returns:

a PathNotificationSession

Throws:

NullArgumentException - pathReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsPathNotification()} is {@code true} .

getPathNotificationSessionForMap

PathNotificationSession getPathNotificationSessionForMap(PathReceiver pathReceiver,
 Id mapId)
                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

pathReceiver - the notification callback

mapId - the Id of the Map

Returns:

a PathNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - pathReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPathNotification()} and {@code supportsVisibleFederation()} are {@code true}

getPathMapSession

PathMapSession getPathMapSession()
                          throws OperationFailedException

Gets the OsidSession to lookup path/map mappings.

Returns:

a PathMapSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathMap() is false

Compliance:

optional - This method must be implemented if {@code supportsPathMap()} is {@code true} .

getPathMapAssignmentSession

PathMapAssignmentSession getPathMapAssignmentSession()
                                              throws OperationFailedException

Gets the OsidSession associated with assigning paths to maps.

Returns:

a PathMapAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathMapAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsPathMapAssignment()} is {@code true} .

getPathSmartMapSession

PathSmartMapSession getPathSmartMapSession(Id mapId)
                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage path smart maps.

Parameters:

mapId - the Id of the Map

Returns:

a PathSmartMapSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathSmartMap() is false

Compliance:

optional - This method must be implemented if {@code supportsPathSmartMap()} is {@code true} .

getPathSpatialSession

PathSpatialSession getPathSpatialSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the path spatial service.

Returns:

a PathSpatialSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathSpatial() is false

Compliance:

optional - This method must be implemented if {@code supportsPathSpatial()} is {@code true} .

getPathSpatialSessionForMap

PathSpatialSession getPathSpatialSessionForMap(Id mapId)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a PathSpatialSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathSpatial() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPathSpatial()} and {@code supportsVisibleFederation()} are {@code true}

getPathSpatialDesignSession

PathSpatialDesignSession getPathSpatialDesignSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the path spatial design service.

Returns:

a PathSpatialDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathSpatialDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsPathSpatialDesign()} is {@code true} .

getPathSpatialDesignSessionForMap

PathSpatialDesignSession getPathSpatialDesignSessionForMap(Id mapId)
                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a PathSpatialDesignSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathSpatialDesign() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPathSpatialDesign()} and {@code supportsVisibleFederation()} are {@code true}

getPathTravelSession

PathTravelSession getPathTravelSession()
                                throws OperationFailedException

Gets the OsidSession associated with the path travel service.

Returns:

a PathTravelSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsPathTravel() is false

Compliance:

optional - This method must be implemented if {@code supportsPathTravel()} is {@code true} .

getPathTravelSessionForMap

PathTravelSession getPathTravelSessionForMap(Id mapId)
                                      throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a PathTravelSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsPathTravel() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsPathTravel()} and {@code supportsVisibleFederation()} are {@code true}

getResourcePathNotificationSession

ResourcePathNotificationSession getResourcePathNotificationSession(ResourcePathReceiver resourcePathReceiver)
                                                            throws OperationFailedException

Gets the OsidSession associated with the resource path notification service.

Parameters:

resourcePathReceiver - the notification callback

Returns:

a ResourcePathNotificationSession

Throws:

NullArgumentException - resourcePathReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourcePathNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsResourcePathNotification()} is {@code true} .

getResourcePathNotificationSessionForMap

ResourcePathNotificationSession getResourcePathNotificationSessionForMap(ResourcePathReceiver resourcePathReceiver,
 Id mapId)
                                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

resourcePathReceiver - the notification callback

mapId - the Id of the Map

Returns:

a ResourcePathNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - resourcePathReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourcePathNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsResourcePathNotification()} and {@code supportsVisibleFederation()} are {@code true}

getResourceVelocitySession

ResourceVelocitySession getResourceVelocitySession()
                                            throws OperationFailedException

Gets the OsidSession associated with the resource velocity service.

Returns:

a ResourceVelocitySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceVelocity() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceVelocity()} is {@code true} .

getResourceVelocitySessionForMap

ResourceVelocitySession getResourceVelocitySessionForMap(Id mapId)
                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a ResourceVelocitySession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceVelocity() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceVelocity()} and {@code supportsVisibleFederation()} are {@code true}

getResourceVelocityUpdateSession

ResourceVelocityUpdateSession getResourceVelocityUpdateSession()
                                                        throws OperationFailedException

Gets the OsidSession associated with the resource velocity update service.

Returns:

a ResourceVelocityUpdateSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceVelocityUpdate() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceVelocityUpdate()} is {@code true} .

getResourceVelocityUpdateSessionForMap

ResourceVelocityUpdateSession getResourceVelocityUpdateSessionForMap(Id mapId)
                                                              throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a ResourceVelocityUpdateSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceVelocityUpdate() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceVelocityUpdate()} and {@code supportsVisibleFederation()} are {@code true}

getResourceVelocityNotificationSession

ResourceVelocityNotificationSession getResourceVelocityNotificationSession(ResourceVelocityReceiver resourceVelocityReceiver)
                                                                    throws OperationFailedException

Gets the OsidSession associated with the resource velocity notification service.

Parameters:

resourceVelocityReceiver - the notification callback

Returns:

a ResourceVelocityNotificationSession

Throws:

NullArgumentException - resourceVelocityReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceVelocityNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceVelocityNotification()} is {@code true} .

getResourceVelocityNotificationSessionForMap

ResourceVelocityNotificationSession getResourceVelocityNotificationSessionForMap(ResourceVelocityReceiver resourceVelocityReceiver,
 Id mapId)
                                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

resourceVelocityReceiver - the notification callback

mapId - the Id of the Map

Returns:

a ResourceVelocityNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - resourceVelocityReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceVelocityNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceVelocityNotification()} and {@code supportsVisibleFederation()} are {@code true}

getMyPathSession

MyPathSession getMyPathSession()
                        throws OperationFailedException

Gets the OsidSession associated with the my path service.

Returns:

a MyPathSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMyPath() is false

Compliance:

optional - This method must be implemented if {@code supportsMyPath()} is {@code true} .

getMyPathSessionForMap

MyPathSession getMyPathSessionForMap(Id mapId)
                              throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a MyPathSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyPath() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMyPath()} and {@code supportsVisibleFederation()} are {@code true}

getIntersectionLookupSession

IntersectionLookupSession getIntersectionLookupSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the intersection lookup service.

Returns:

an IntersectionLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsIntersectionLookup()} is {@code true} .

getIntersectionLookupSessionForMap

IntersectionLookupSession getIntersectionLookupSessionForMap(Id mapId)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an IntersectionLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsIntersectionLookup()} and {@code supportsVisibleFederation()} are {@code true}

getIntersectionQuerySession

IntersectionQuerySession getIntersectionQuerySession()
                                              throws OperationFailedException

Gets the OsidSession associated with the intersection query service.

Returns:

an IntersectionQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsIntersectionQuery()} is {@code true} .

getIntersectionQuerySessionForMap

IntersectionQuerySession getIntersectionQuerySessionForMap(Id mapId)
                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an IntersectionQuerySession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsIntersectionQuery()} and {@code supportsVisibleFederation()} are {@code true}

getIntersectionSearchSession

IntersectionSearchSession getIntersectionSearchSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the intersection search service.

Returns:

an IntersectionSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsIntersectionSearch()} is {@code true} .

getIntersectionSearchSessionForMap

IntersectionSearchSession getIntersectionSearchSessionForMap(Id mapId)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an IntersectionSearchSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsIntersectionSearch()} and {@code supportsVisibleFederation()} are {@code true}

getIntersectionAdminSession

IntersectionAdminSession getIntersectionAdminSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the intersection administrative service.

Returns:

an IntersectionAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsIntersectionAdmin()} is {@code true} .

getIntersectionAdminSessionForMap

IntersectionAdminSession getIntersectionAdminSessionForMap(Id mapId)
                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an IntersectionAdminSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsIntersectionAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getIntersectionNotificationSession

IntersectionNotificationSession getIntersectionNotificationSession(IntersectionReceiver intersectionReceiver)
                                                            throws OperationFailedException

Gets the OsidSession associated with the intersection notification service.

Parameters:

intersectionReceiver - the notification callback

Returns:

an IntersectionNotificationSession

Throws:

NullArgumentException - intersectionReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsIntersectionNotification()} is {@code true} .

getIntersectionNotificationSessionForMap

IntersectionNotificationSession getIntersectionNotificationSessionForMap(IntersectionReceiver intersectionReceiver,
 Id mapId)
                                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

intersectionReceiver - the notification callback

mapId - the Id of the Map

Returns:

an IntersectionNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - intersectionReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsIntersectionNotification()} and {@code supportsVisibleFederation()} are {@code true}

getIntersectionMapSession

IntersectionMapSession getIntersectionMapSession()
                                          throws OperationFailedException

Gets the OsidSession to lookup intersection/map mappings.

Returns:

an IntersectionMapSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionMap() is false

Compliance:

optional - This method must be implemented if {@code supportsIntersectionMap()} is {@code true} .

getIntersectionMapAssignmentSession

IntersectionMapAssignmentSession getIntersectionMapAssignmentSession()
                                                              throws OperationFailedException

Gets the OsidSession associated with assigning intersections to maps.

Returns:

an IntersectionMapAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionMapAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsIntersectionMapAssignment()} is {@code true} .

getIntersectionSmartMapSession

IntersectionSmartMapSession getIntersectionSmartMapSession(Id mapId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage intersection smart maps.

Parameters:

mapId - the Id of the Map

Returns:

an IntersectionSmartMapSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIntersectionSmartMap() is false

Compliance:

optional - This method must be implemented if {@code supportsIntersectionSmartMap()} is {@code true} .

getSpeedZoneLookupSession

SpeedZoneLookupSession getSpeedZoneLookupSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the speed zone lookup service.

Returns:

a SpeedZoneLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneLookup()} is {@code true} .

getSpeedZoneLookupSessionForMap

SpeedZoneLookupSession getSpeedZoneLookupSessionForMap(Id mapId)
                                                throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the map

Returns:

a SpeedZoneLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneLookup()} and {@code supportsVisibleFederation()} are {@code true}

getSpeedZoneQuerySession

SpeedZoneQuerySession getSpeedZoneQuerySession()
                                        throws OperationFailedException

Gets the OsidSession associated with the speed zone query service.

Returns:

a SpeedZoneQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneQuery()} is {@code true} .

getSpeedZoneQuerySessionForMap

SpeedZoneQuerySession getSpeedZoneQuerySessionForMap(Id mapId)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SpeedZoneQuerySession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneQuery()} and {@code supportsVisibleFederation()} are {@code true}

getSpeedZoneSearchSession

SpeedZoneSearchSession getSpeedZoneSearchSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the speed zone search service.

Returns:

a SpeedZoneSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneSearch()} is {@code true} .

getSpeedZoneSearchSessionForMap

SpeedZoneSearchSession getSpeedZoneSearchSessionForMap(Id mapId)
                                                throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SpeedZoneSearchSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneSearch()} and {@code supportsVisibleFederation()} are {@code true}

getSpeedZoneAdminSession

SpeedZoneAdminSession getSpeedZoneAdminSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the speed zone administration service.

Returns:

a SpeedZoneAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneAdmin()} is {@code true} .

getSpeedZoneAdminSessionForMap

SpeedZoneAdminSession getSpeedZoneAdminSessionForMap(Id mapId)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SpeedZoneAdminSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getSpeedZoneNotificationSession

SpeedZoneNotificationSession getSpeedZoneNotificationSession(SpeedZoneReceiver speedZoneReceiver)
                                                      throws OperationFailedException

Gets the OsidSession associated with the speed zone notification service.

Parameters:

speedZoneReceiver - the notification callback

Returns:

a SpeedZoneNotificationSession

Throws:

NullArgumentException - speedZoneReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneNotification()} is {@code true} .

getSpeedZoneNotificationSessionForMap

SpeedZoneNotificationSession getSpeedZoneNotificationSessionForMap(SpeedZoneReceiver speedZoneReceiver,
 Id mapId)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

speedZoneReceiver - the notification callback

mapId - the Id of the Map

Returns:

a SpeedZoneNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - speedZoneReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneNotification()} and {@code supportsVisibleFederation()} are {@code true}

getSpeedZoneMapSession

SpeedZoneMapSession getSpeedZoneMapSession()
                                    throws OperationFailedException

Gets the OsidSession to lookup speed zone/map mappings.

Returns:

a SpeedZoneMapSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneMap() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneMap()} is {@code true} .

getSpeedZoneMapAssignmentSession

SpeedZoneMapAssignmentSession getSpeedZoneMapAssignmentSession()
                                                        throws OperationFailedException

Gets the OsidSession associated with assigning speed zones to maps.

Returns:

a SpeedZoneMapAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneMapAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneMapAssignment()} is {@code true} .

getSpeedZoneSmartMapSession

SpeedZoneSmartMapSession getSpeedZoneSmartMapSession(Id mapId)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage locatin smart maps.

Parameters:

mapId - the Id of the Map

Returns:

a SpeedZoneSmartMapSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSpeedZoneSmartMap() is false

Compliance:

optional - This method must be implemented if {@code supportsSpeedZoneSmartMap()} is {@code true} .

getSignalLookupSession

SignalLookupSession getSignalLookupSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the signal lookup service.

Returns:

a SignalLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalLookup()} is {@code true} .

getSignalLookupSessionForMap

SignalLookupSession getSignalLookupSessionForMap(Id mapId)
                                          throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the map

Returns:

a SignalLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalLookup()} and {@code supportsVisibleFederation()} are {@code true}

getSignalQuerySession

SignalQuerySession getSignalQuerySession()
                                  throws OperationFailedException

Gets the OsidSession associated with the signal query service.

Returns:

a SignalQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalQuery()} is {@code true} .

getSignalQuerySessionForMap

SignalQuerySession getSignalQuerySessionForMap(Id mapId)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SignalQuerySession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalQuery()} and {@code supportsVisibleFederation()} are {@code true}

getSignalSearchSession

SignalSearchSession getSignalSearchSession()
                                    throws OperationFailedException

Gets the OsidSession associated with the signal search service.

Returns:

a SignalSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalSearch()} is {@code true} .

getSignalSearchSessionForMap

SignalSearchSession getSignalSearchSessionForMap(Id mapId)
                                          throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SignalSearchSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalSearch()} and {@code supportsVisibleFederation()} are {@code true}

getSignalAdminSession

SignalAdminSession getSignalAdminSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the signal administration service.

Returns:

a SignalAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalAdmin()} is {@code true} .

getSignalAdminSessionForMap

SignalAdminSession getSignalAdminSessionForMap(Id mapId)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a SignalAdminSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getSignalNotificationSession

SignalNotificationSession getSignalNotificationSession(SignalReceiver signalReceiver)
                                                throws OperationFailedException

Gets the OsidSession associated with the signal notification service.

Parameters:

signalReceiver - the notification callback

Returns:

a SignalNotificationSession

Throws:

NullArgumentException - signalReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalNotification()} is {@code true} .

getSignalNotificationSessionForMap

SignalNotificationSession getSignalNotificationSessionForMap(SignalReceiver signalReceiver,
 Id mapId)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

signalReceiver - the notification callback

mapId - the Id of the Map

Returns:

a SignalNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - signalReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalNotification()} and {@code supportsVisibleFederation()} are {@code true}

getSignalMapSession

SignalMapSession getSignalMapSession()
                              throws OperationFailedException

Gets the OsidSession to lookup signal/map mappings.

Returns:

a SignalMapSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalMap() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalMap()} is {@code true} .

getSignalMapAssignmentSession

SignalMapAssignmentSession getSignalMapAssignmentSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with assigning signals to maps.

Returns:

a SignalMapAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalMapAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalMapAssignment()} is {@code true} .

getSignalSmartMapSession

SignalSmartMapSession getSignalSmartMapSession(Id mapId)
                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage locatin smart maps.

Parameters:

mapId - the Id of the Map

Returns:

a SignalSmartMapSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSignalSmartMap() is false

Compliance:

optional - This method must be implemented if {@code supportsSignalSmartMap()} is {@code true} .

getResourceSignalNotificationSession

ResourceSignalNotificationSession getResourceSignalNotificationSession(ResourceVelocityReceiver resourceSignalReceiver)
                                                                throws OperationFailedException

Gets the OsidSession associated with the resource signal notification service.

Parameters:

resourceSignalReceiver - the notification callback

Returns:

a ResourceSignaNotificationSession

Throws:

NullArgumentException - resourceSignaReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceSignaNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceSignaNotification()} is {@code true} .

getResourceSignalNotificationSessionForMap

ResourceSignalNotificationSession getResourceSignalNotificationSessionForMap(ResourceVelocityReceiver resourceSignalReceiver,
 Id mapId)
                                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

resourceSignalReceiver - the notification callback

mapId - the Id of the Map

Returns:

a ResourceSignaNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - resourceSignalReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceSignaNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceSignaNotification()} and {@code supportsVisibleFederation()} are {@code true}

getObstacleLookupSession

ObstacleLookupSession getObstacleLookupSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the obstacle lookup service.

Returns:

an ObstacleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleLookup()} is {@code true} .

getObstacleLookupSessionForMap

ObstacleLookupSession getObstacleLookupSessionForMap(Id mapId)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the map

Returns:

an ObstacleLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleLookup()} and {@code supportsVisibleFederation()} are {@code true}

getObstacleQuerySession

ObstacleQuerySession getObstacleQuerySession()
                                      throws OperationFailedException

Gets the OsidSession associated with the obstacle query service.

Returns:

an ObstacleQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleQuery()} is {@code true} .

getObstacleQuerySessionForMap

ObstacleQuerySession getObstacleQuerySessionForMap(Id mapId)
                                            throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an ObstacleQuerySession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleQuery()} and {@code supportsVisibleFederation()} are {@code true}

getObstacleSearchSession

ObstacleSearchSession getObstacleSearchSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the obstacle search service.

Returns:

an ObstacleSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleSearch()} is {@code true} .

getObstacleSearchSessionForMap

ObstacleSearchSession getObstacleSearchSessionForMap(Id mapId)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an ObstacleSearchSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleSearch()} and {@code supportsVisibleFederation()} are {@code true}

getObstacleAdminSession

ObstacleAdminSession getObstacleAdminSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the obstacle administration service.

Returns:

an ObstacleAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleAdmin()} is {@code true} .

getObstacleAdminSessionForMap

ObstacleAdminSession getObstacleAdminSessionForMap(Id mapId)
                                            throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

an ObstacleAdminSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getObstacleNotificationSession

ObstacleNotificationSession getObstacleNotificationSession(ObstacleReceiver obstacleReceiver)
                                                    throws OperationFailedException

Gets the OsidSession associated with the obstacle notification service.

Parameters:

obstacleReceiver - the notification callback

Returns:

an ObstacleNotificationSession

Throws:

NullArgumentException - obstacleReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleNotification()} is {@code true} .

getObstacleNotificationSessionForMap

ObstacleNotificationSession getObstacleNotificationSessionForMap(ObstacleReceiver obstacleReceiver,
 Id mapId)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

obstacleReceiver - the notification callback

mapId - the Id of the Map

Returns:

an ObstacleNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - obstacleReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleNotification()} and {@code supportsVisibleFederation()} are {@code true}

getObstacleMapSession

ObstacleMapSession getObstacleMapSession()
                                  throws OperationFailedException

Gets the OsidSession to lookup obstacle/map mappings.

Returns:

an ObstacleMapSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleMap() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleMap()} is {@code true} .

getObstacleMapAssignmentSession

ObstacleMapAssignmentSession getObstacleMapAssignmentSession()
                                                      throws OperationFailedException

Gets the OsidSession associated with assigning obstacles to maps.

Returns:

an ObstacleMapAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleMapAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleMapAssignment()} is {@code true} .

getObstacleSmartMapSession

ObstacleSmartMapSession getObstacleSmartMapSession(Id mapId)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage locatin smart maps.

Parameters:

mapId - the Id of the Map

Returns:

an ObstacleSmartMapSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsObstacleSmartMap() is false

Compliance:

optional - This method must be implemented if {@code supportsObstacleSmartMap()} is {@code true} .

getMappingPathBatchManager

MappingPathBatchManager getMappingPathBatchManager()
                                            throws OperationFailedException

Gets a MappingPathBatchManager .

Returns:

a MappingPathBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMappingPathBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsMappingPathBatch()} is {@code true} .

getMappingPathRulesManager

MappingPathRulesManager getMappingPathRulesManager()
                                            throws OperationFailedException

Gets a MappingPathRulesManager .

Returns:

a MappingPathRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMappingPathRules() is false

Compliance:

optional - This method must be implemented if {@code supportsMappingPathRules()} is {@code true} .