public interface MappingRouteManager extends OsidManager, MappingRouteProfile
The mapping route manager provides access to routing sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
RoutingSession:
a session to access routes to
locations RouteLookupSession:
a session to retrieve routes
RouteQuerySession:
a session to query for routes
RouteSearchSession:
a session to search for routes
RouteAdminSession:
a session to create and delete
routes RouteNotificationSession:
a session to receive
notifications pertaining to route changes RouteMapSession:
a session to looking locations of
routes to maps RouteMapAssignmentSession:
a session to manage
route to map mappings RouteSmartMapSession:
a session to manage dynamic
maps of routes ResourceRouteSession:
a session to find resources
on routes ResourceRouteAssignmentSession:
a session to
manage resources on routes ResourceRouteNotificationSession:
a session to
subscribe to notifications of resources moving on routes MyRouteSession:
a session to manage the route of
the current user agent Modifier and Type | Method and Description |
---|---|
MyRouteSession |
getMyRouteSession()
Gets the
OsidSession associated with the my route
service. |
MyRouteSession |
getMyRouteSessionForMap(Id mapId)
Gets the
OsidSession associated with the my route
service for the given map. |
ResourceRouteAssignmentSession |
getResourceRouteAssignmentSession()
Gets the
OsidSession associated with the resource route
assignment service. |
ResourceRouteAssignmentSession |
getResourceRouteAssignmentSessionForMap(Id mapId)
Gets the
OsidSession associated with the resource route
assignment service for the given map. |
ResourceRouteNotificationSession |
getResourceRouteNotificationSession(ResourceRouteReceiver resourceRouteReceiver)
Gets the
OsidSession associated with the resource route
notification service. |
ResourceRouteNotificationSession |
getResourceRouteNotificationSessionForMap(ResourceRouteReceiver resourceRouteReceiver,
Id mapId)
Gets the
OsidSession associated with the resource route
notification service for the given map. |
ResourceRouteSession |
getResourceRouteSession()
Gets the
OsidSession associated with the resource route
service. |
ResourceRouteSession |
getResourceRouteSessionForMap(Id mapId)
Gets the
OsidSession associated with the resource route
service for the given map. |
RouteAdminSession |
getRouteAdminSession()
Gets the
OsidSession associated with the route
administration service. |
RouteAdminSession |
getRouteAdminSessionForMap(Id mapId)
Gets the
OsidSession associated with the route
administration service for the given map. |
RouteLookupSession |
getRouteLookupSession()
Gets the
OsidSession associated with the route lookup
service. |
RouteLookupSession |
getRouteLookupSessionForMap(Id mapId)
Gets the
OsidSession associated with the route lookup
service for the given map. |
RouteMapAssignmentSession |
getRouteMapAssignmentSession()
Gets the
OsidSession associated with assigning routes
to maps. |
RouteMapSession |
getRouteMapSession()
Gets the
OsidSession to lookup route/map mappings. |
RouteNotificationSession |
getRouteNotificationSession(RouteReceiver routeReceiver)
Gets the
OsidSession associated with the route
notification service. |
RouteNotificationSession |
getRouteNotificationSessionForMap(RouteReceiver routeReceiver,
Id mapId)
Gets the
OsidSession associated with the route
notification service for the given map. |
RouteQuerySession |
getRouteQuerySession()
Gets the
OsidSession associated with the route query
service. |
RouteQuerySession |
getRouteQuerySessionForMap(Id mapId)
Gets the
OsidSession associated with the route query
service for the given map. |
RouteSearchSession |
getRouteSearchSession()
Gets the
OsidSession associated with the route search
service. |
RouteSearchSession |
getRouteSearchSessionForMap(Id mapId)
Gets the
OsidSession associated with the route search
service for the given map. |
RouteSmartMapSession |
getRouteSmartMapSession(Id mapId)
Gets the
OsidSession to manage route smart maps. |
RoutingSession |
getRoutingSession()
Gets the
OsidSession associated with the location
routing service. |
RoutingSession |
getRoutingSessionForMap(Id mapId)
Gets the
OsidSession associated with the location
routing service for the given map. |
changeBranch, initialize, rollbackService
close
getRouteProgressRecordTypes, getRouteRecordTypes, getRouteSearchRecordTypes, getRouteSegmentRecordTypes, supportsLocationRouting, supportsMyLocation, supportsMyRoute, supportsResourceRoute, supportsResourceRouteAssignment, supportsResourceRouteNotification, supportsRouteAdmin, supportsRouteLookup, supportsRouteMap, supportsRouteMapAssignment, supportsRouteNotification, supportsRouteProgressRecordType, supportsRouteQuery, supportsRouteRecordType, supportsRouteSearch, supportsRouteSearchRecordType, supportsRouteSegmentRecordType, supportsRouteSmartMap, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
RoutingSession getRoutingSession() throws OperationFailedException
OsidSession
associated with the location
routing service. RoutingSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouting()
is false
optional
- This method must be implemented if
supportsRouting()
is true.
RoutingSession getRoutingSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the location
routing service for the given map.mapId
- the Id
of the Map
RoutingSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouting()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRouting()
and
supportsVisibleFederation()
are true
RouteLookupSession getRouteLookupSession() throws OperationFailedException
OsidSession
associated with the route lookup
service. RouteLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteLookup()
is false
optional
- This method must be implemented if
supportsRouteLookup()
is true.
RouteLookupSession getRouteLookupSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the route lookup
service for the given map.mapId
- the Id
of the map RouteLookupSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRouteLookup()
and
supportsVisibleFederation()
are true
RouteQuerySession getRouteQuerySession() throws OperationFailedException
OsidSession
associated with the route query
service. RouteQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteQuery()
is false
optional
- This method must be implemented if
supportsRouteQuery()
is true.
RouteQuerySession getRouteQuerySessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the route query
service for the given map.mapId
- the Id
of the map RouteQuerySession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRouteQuery()
and
supportsVisibleFederation()
are true
RouteSearchSession getRouteSearchSession() throws OperationFailedException
OsidSession
associated with the route search
service. RouteSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteSearch()
is false
optional
- This method must be implemented if
supportsRouteSearch()
is true.
RouteSearchSession getRouteSearchSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the route search
service for the given map.mapId
- the Id
of the Map
RouteSearchSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRouteSearch()
and
supportsVisibleFederation()
are true
RouteAdminSession getRouteAdminSession() throws OperationFailedException
OsidSession
associated with the route
administration service. RouteAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteAdmin()
is false
optional
- This method must be implemented if
supportsRouteAdmin()
is true.
RouteAdminSession getRouteAdminSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the route
administration service for the given map.mapId
- the Id
of the Map
RouteAdminSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsRouteAdmin()
and
supportsVisibleFederation()
are true
RouteNotificationSession getRouteNotificationSession(RouteReceiver routeReceiver) throws OperationFailedException
OsidSession
associated with the route
notification service.routeReceiver
- the notification callback RouteNotificationSession
NullArgumentException
- routeReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRouteNotification()
is false
optional
- This method must be implemented if
supportsRouteNotification()
is true.
RouteNotificationSession getRouteNotificationSessionForMap(RouteReceiver routeReceiver, Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the route
notification service for the given map.routeReceiver
- the notification callbackmapId
- the Id
of the Map
RouteNotificationSession
NotFoundException
- no map found by the given Id
NullArgumentException
- routeReceiver
or
mapId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRouteNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsRouteNotification()
and
supportsVisibleFederation()
are true
RouteMapSession getRouteMapSession() throws OperationFailedException
OsidSession
to lookup route/map mappings. RouteMapSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteMap()
is false
optional
- This method must be implemented if
supportsRouteMap()
is true.
RouteMapAssignmentSession getRouteMapAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning routes
to maps. LocationMapAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRouteMapAssignment()
is false
optional
- This method must be implemented if
supportsRouteMapAssignment()
is true.
RouteSmartMapSession getRouteSmartMapSession(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
to manage route smart maps.mapId
- the Id
of the Map
RouteSmartMapSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteSmartMap()
is false
optional
- This method must be implemented if
supportsRouteSmartMap()
is true.
ResourceRouteSession getResourceRouteSession() throws OperationFailedException
OsidSession
associated with the resource route
service. ResourceRouteSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsResourceRoute()
is false
optional
- This method must be implemented if
supportsResourceRoute()
is true.
ResourceRouteSession getResourceRouteSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the resource route
service for the given map.mapId
- the Id
of the Map
ResourceRouteSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsResourceRoute()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsResourceRoute()
and
supportsVisibleFederation()
are true
ResourceRouteAssignmentSession getResourceRouteAssignmentSession() throws OperationFailedException
OsidSession
associated with the resource route
assignment service. ResourceRouteAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourceRouteAssignment()
is false
optional
- This method must be implemented if
supportsResourceRouteAssignment()
is true.
ResourceRouteAssignmentSession getResourceRouteAssignmentSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the resource route
assignment service for the given map.mapId
- the Id
of the Map
ResourceRouteAssignmentSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourceRouteAssignment()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsResourceRouteAssignment()
and
supportsVisibleFederation()
are true
ResourceRouteNotificationSession getResourceRouteNotificationSession(ResourceRouteReceiver resourceRouteReceiver) throws OperationFailedException
OsidSession
associated with the resource route
notification service.resourceRouteReceiver
- the notification callback ResourceRouteNotificationSession
NullArgumentException
- resourceRouteReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourceRouteNotification()
is false
optional
- This method must be implemented if
supportsResourceRouteNotification()
is
true.
ResourceRouteNotificationSession getResourceRouteNotificationSessionForMap(ResourceRouteReceiver resourceRouteReceiver, Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the resource route
notification service for the given map.resourceRouteReceiver
- the notification callbackmapId
- the Id
of the Map
ResourceRouteNotificationSession
NotFoundException
- no map found by the given Id
NullArgumentException
- resourceRouteReceiver
or mapId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourceRouteNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsResourceRouteNotification()
and
supportsVisibleFederation()
are true
MyRouteSession getMyRouteSession() throws OperationFailedException
OsidSession
associated with the my route
service. MyRouteLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMyRouteLookup()
is false
optional
- This method must be implemented if
supportsMyRouteLookup()
is true.
MyRouteSession getMyRouteSessionForMap(Id mapId) throws NotFoundException, OperationFailedException
OsidSession
associated with the my route
service for the given map.mapId
- the Id
of the map MyRouteLookupSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMyRouteLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMyRouteLookup()
and
supportsVisibleFederation()
are true