public interface MappingRouteProxyManager extends OsidProxyManager, MappingRouteProfile
The mapping proxy manager provides access to routing sessions and
provides interoperability tests for various aspects of this service.
Methods in this manager pass a Proxy
for passing
information from server environments. The sessions included in this
manager are:
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(Proxy proxy)
Gets the
OsidSession associated with the my route
service. |
MyRouteSession |
getMyRouteSessionForMap(Id mapId,
Proxy proxy)
Gets the
OsidSession associated with the my route
service for the given map. |
ResourceRouteAssignmentSession |
getResourceRouteAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with the resource route
assignment service. |
ResourceRouteAssignmentSession |
getResourceRouteAssignmentSessionForMap(Id mapId,
Proxy proxy)
Gets the
OsidSession associated with the resource route
assignment service for the given map. |
ResourceRouteNotificationSession |
getResourceRouteNotificationSession(ResourceRouteReceiver resourceRouteReceiver,
Proxy proxy)
Gets the
OsidSession associated with the resource route
notification service. |
ResourceRouteNotificationSession |
getResourceRouteNotificationSessionForMap(ResourceRouteReceiver resourceRouteReceiver,
Id mapId,
Proxy proxy)
Gets the
OsidSession associated with the resource route
notification service for the given map. |
ResourceRouteSession |
getResourceRouteSession(Proxy proxy)
Gets the
OsidSession associated with the resource route
service. |
ResourceRouteSession |
getResourceRouteSessionForMap(Id mapId,
Proxy proxy)
Gets the
OsidSession associated with the resource route
service for the given map. |
RouteAdminSession |
getRouteAdminSession(Proxy proxy)
Gets the
OsidSession associated with the route
administration service. |
RouteAdminSession |
getRouteAdminSessionForMap(Id mapId,
Proxy proxy)
Gets the
OsidSession associated with the route
administration service for the given map. |
RouteLookupSession |
getRouteLookupSession(Proxy proxy)
Gets the
OsidSession associated with the route lookup
service. |
RouteLookupSession |
getRouteLookupSessionForMap(Id mapId,
Proxy proxy)
Gets the
OsidSession associated with the route lookup
service for the given map. |
RouteMapAssignmentSession |
getRouteMapAssignmentSession(Proxy proxy)
Gets the
OsidSession associated with assigning routes
to maps. |
RouteMapSession |
getRouteMapSession(Proxy proxy)
Gets the
OsidSession to lookup route/map mappings. |
RouteNotificationSession |
getRouteNotificationSession(RouteReceiver routeReceiver,
Proxy proxy)
Gets the
OsidSession associated with the route
notification service. |
RouteNotificationSession |
getRouteNotificationSessionForMap(RouteReceiver routeReceiver,
Id mapId,
Proxy proxy)
Gets the
OsidSession associated with the route
notification service for the given map. |
RouteQuerySession |
getRouteQuerySession(Proxy proxy)
Gets the
OsidSession associated with the route query
service. |
RouteQuerySession |
getRouteQuerySessionForMap(Id mapId,
Proxy proxy)
Gets the
OsidSession associated with the route query
service for the given map. |
RouteSearchSession |
getRouteSearchSession(Proxy proxy)
Gets the
OsidSession associated with the route search
service. |
RouteSearchSession |
getRouteSearchSessionForMap(Id mapId,
Proxy proxy)
Gets the
OsidSession associated with the route search
service for the given map. |
RouteSmartMapSession |
getRouteSmartMapSession(Id mapId,
Proxy proxy)
Gets the
OsidSession to manage route smart maps. |
RoutingSession |
getRoutingSession(Proxy proxy)
Gets the
OsidSession associated with the location
routing service. |
RoutingSession |
getRoutingSessionForMap(Id mapId,
Proxy proxy)
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the location
routing service.proxy
- a proxy RoutingSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouting()
is false
optional
- This method must be implemented if
supportsRouting()
is true.
RoutingSession getRoutingSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the location
routing service for the given map.mapId
- the Id
of the Map
proxy
- a proxy RoutingSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the route lookup
service.proxy
- a proxy RouteLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteLookup()
is false
optional
- This method must be implemented if
supportsRouteLookup()
is true.
RouteLookupSession getRouteLookupSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the route lookup
service for the given map.mapId
- the Id
of the mapproxy
- a proxy RouteLookupSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the route query
service.proxy
- a proxy RouteQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteQuery()
is false
optional
- This method must be implemented if
supportsRouteQuery()
is true.
RouteQuerySession getRouteQuerySessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the route query
service for the given map.mapId
- the Id
of the mapproxy
- a proxy RouteQuerySession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the route search
service.proxy
- a proxy RouteSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteSearch()
is false
optional
- This method must be implemented if
supportsRouteSearch()
is true.
RouteSearchSession getRouteSearchSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the route search
service for the given map.mapId
- the Id
of the Map
proxy
- a proxy RouteSearchSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the route
administration service.proxy
- a proxy RouteAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteAdmin()
is false
optional
- This method must be implemented if
supportsRouteAdmin()
is true.
RouteAdminSession getRouteAdminSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the route
administration service for the given map.mapId
- the Id
of the Map
proxy
- a proxy RouteAdminSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
or
proxy
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the route
notification service.routeReceiver
- the notification callbackproxy
- a proxy RouteNotificationSession
NullArgumentException
- routeReceiver
or
proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the route
notification service for the given map.routeReceiver
- the notification callbackmapId
- the Id
of the Map
proxy
- a proxy RouteNotificationSession
NotFoundException
- no map found by the given Id
NullArgumentException
- routeReceiver, mapId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
to lookup route/map mappings.proxy
- a proxy RouteMapSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteMap()
is false
optional
- This method must be implemented if
supportsRouteMap()
is true.
RouteMapAssignmentSession getRouteMapAssignmentSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with assigning routes
to maps.proxy
- a proxy LocationMapAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsRouteMapAssignment()
is false
optional
- This method must be implemented if
supportsRouteMapAssignment()
is true.
RouteSmartMapSession getRouteSmartMapSession(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
to manage route smart maps.mapId
- the Id
of the Map
proxy
- a proxy RouteSmartMapSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsRouteSmartMap()
is false
optional
- This method must be implemented if
supportsRouteSmartMap()
is true.
ResourceRouteSession getResourceRouteSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the resource route
service.proxy
- a proxy ResourceRouteSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsResourceRoute()
is false
optional
- This method must be implemented if
supportsResourceRoute()
is true.
ResourceRouteSession getResourceRouteSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the resource route
service for the given map.mapId
- the Id
of the Map
proxy
- a proxy ResourceRouteSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
or
proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the resource route
assignment service.proxy
- a proxy ResourceRouteAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResourceRouteAssignment()
is false
optional
- This method must be implemented if
supportsResourceRouteAssignment()
is true.
ResourceRouteAssignmentSession getResourceRouteAssignmentSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the resource route
assignment service for the given map.mapId
- the Id
of the Map
proxy
- a proxy ResourceRouteAssignmentSession
NotFoundException
- no map found by the given Id
NullArgumentException
- mapId
or
proxy
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, Proxy proxy) throws OperationFailedException
OsidSession
associated with the resource route
notification service.resourceRouteReceiver
- the notification callbackproxy
- a proxy ResourceRouteNotificationSession
NullArgumentException
- resourceRouteReceiver
or proxy
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, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the resource route
notification service for the given map.resourceRouteReceiver
- the notification callbackmapId
- the Id
of the Map
proxy
- a proxy ResourceRouteNotificationSession
NotFoundException
- no map found by the given Id
NullArgumentException
- resourceRouteReceiver,
mapId
or proxy
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(Proxy proxy) throws OperationFailedException
OsidSession
associated with the my route
service.proxy
- a proxy MyRouteLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMyRouteLookup()
is false
optional
- This method must be implemented if
supportsMyRouteLookup()
is true.
MyRouteSession getMyRouteSessionForMap(Id mapId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the my route
service for the given map.mapId
- the Id
of the mapproxy
- a proxy MyRouteLookupSession
NotFoundException
- no Map
found by the
given Id
NullArgumentException
- mapId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMyRouteLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMyRouteLookup()
and
supportsVisibleFederation()
are true