org.osid.mapping.route

Interface MappingRouteProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, MappingRouteProfile, OsidProfile, OsidProxyManager, Sourceable

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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.mapping.route.MappingRouteProfile

getRouteProgressRecordTypes, getRouteRecordTypes, getRouteSearchRecordTypes, getRouteSegmentRecordTypes, supportsLocationRouting, supportsMyLocation, supportsMyRoute, supportsResourceRoute, supportsResourceRouteAssignment, supportsResourceRouteNotification, supportsRouteAdmin, supportsRouteLookup, supportsRouteMap, supportsRouteMapAssignment, supportsRouteNotification, supportsRouteProgressRecordType, supportsRouteQuery, supportsRouteRecordType, supportsRouteSearch, supportsRouteSearchRecordType, supportsRouteSegmentRecordType, supportsRouteSmartMap, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getRoutingSession

RoutingSession getRoutingSession(Proxy proxy)
                                 throws OperationFailedException

Gets the OsidSession associated with the location routing service.

Parameters:

proxy - a proxy

Returns:

a RoutingSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouting() is false

Compliance:

optional - This method must be implemented if supportsRouting() is true.

getRoutingSessionForMap

RoutingSession getRoutingSessionForMap(Id mapId,
                                     Proxy proxy)
                                       throws NotFoundException,
                                              OperationFailedException

Gets the OsidSession associated with the location routing service for the given map.

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a RoutingSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouting() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRouting() and supportsVisibleFederation() are true

getRouteLookupSession

RouteLookupSession getRouteLookupSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the route lookup service.

Parameters:

proxy - a proxy

Returns:

a RouteLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteLookup() is false

Compliance:

optional - This method must be implemented if supportsRouteLookup() is true.

getRouteLookupSessionForMap

RouteLookupSession getRouteLookupSessionForMap(Id mapId,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

mapId - the Id of the map

proxy - a proxy

Returns:

a RouteLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRouteLookup() and supportsVisibleFederation() are true

getRouteQuerySession

RouteQuerySession getRouteQuerySession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the route query service.

Parameters:

proxy - a proxy

Returns:

a RouteQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteQuery() is false

Compliance:

optional - This method must be implemented if supportsRouteQuery() is true.

getRouteQuerySessionForMap

RouteQuerySession getRouteQuerySessionForMap(Id mapId,
                                           Proxy proxy)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

mapId - the Id of the map

proxy - a proxy

Returns:

a RouteQuerySession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRouteQuery() and supportsVisibleFederation() are true

getRouteSearchSession

RouteSearchSession getRouteSearchSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession associated with the route search service.

Parameters:

proxy - a proxy

Returns:

a RouteSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteSearch() is false

Compliance:

optional - This method must be implemented if supportsRouteSearch() is true.

getRouteSearchSessionForMap

RouteSearchSession getRouteSearchSessionForMap(Id mapId,
                                             Proxy proxy)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a RouteSearchSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRouteSearch() and supportsVisibleFederation() are true

getRouteAdminSession

RouteAdminSession getRouteAdminSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the route administration service.

Parameters:

proxy - a proxy

Returns:

a RouteAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteAdmin() is false

Compliance:

optional - This method must be implemented if supportsRouteAdmin() is true.

getRouteAdminSessionForMap

RouteAdminSession getRouteAdminSessionForMap(Id mapId,
                                           Proxy proxy)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a RouteAdminSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRouteAdmin() and supportsVisibleFederation() are true

getRouteNotificationSession

RouteNotificationSession getRouteNotificationSession(RouteReceiver routeReceiver,
                                                   Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the route notification service.

Parameters:

routeReceiver - the notification callback

proxy - a proxy

Returns:

a RouteNotificationSession

Throws:

NullArgumentException - routeReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteNotification() is false

Compliance:

optional - This method must be implemented if supportsRouteNotification() is true.

getRouteNotificationSessionForMap

RouteNotificationSession getRouteNotificationSessionForMap(RouteReceiver routeReceiver,
                                                         Id mapId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

routeReceiver - the notification callback

mapId - the Id of the Map

proxy - a proxy

Returns:

a RouteNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - routeReceiver, mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRouteNotification() and supportsVisibleFederation() are true

getRouteMapSession

RouteMapSession getRouteMapSession(Proxy proxy)
                                   throws OperationFailedException

Gets the OsidSession to lookup route/map mappings.

Parameters:

proxy - a proxy

Returns:

a RouteMapSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteMap() is false

Compliance:

optional - This method must be implemented if supportsRouteMap() is true.

getRouteMapAssignmentSession

RouteMapAssignmentSession getRouteMapAssignmentSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with assigning routes to maps.

Parameters:

proxy - a proxy

Returns:

a LocationMapAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteMapAssignment() is false

Compliance:

optional - This method must be implemented if supportsRouteMapAssignment() is true.

getRouteSmartMapSession

RouteSmartMapSession getRouteSmartMapSession(Id mapId,
                                           Proxy proxy)
                                             throws NotFoundException,
                                                    OperationFailedException

Gets the OsidSession to manage route smart maps.

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a RouteSmartMapSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteSmartMap() is false

Compliance:

optional - This method must be implemented if supportsRouteSmartMap() is true.

getResourceRouteSession

ResourceRouteSession getResourceRouteSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the resource route service.

Parameters:

proxy - a proxy

Returns:

a ResourceRouteSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRoute() is false

Compliance:

optional - This method must be implemented if supportsResourceRoute() is true.

getResourceRouteSessionForMap

ResourceRouteSession getResourceRouteSessionForMap(Id mapId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a ResourceRouteSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRoute() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResourceRoute() and supportsVisibleFederation() are true

getResourceRouteAssignmentSession

ResourceRouteAssignmentSession getResourceRouteAssignmentSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the resource route assignment service.

Parameters:

proxy - a proxy

Returns:

a ResourceRouteAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRouteAssignment() is false

Compliance:

optional - This method must be implemented if supportsResourceRouteAssignment() is true.

getResourceRouteAssignmentSessionForMap

ResourceRouteAssignmentSession getResourceRouteAssignmentSessionForMap(Id mapId,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

Gets the OsidSession associated with the resource route assignment service for the given map.

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a ResourceRouteAssignmentSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRouteAssignment() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResourceRouteAssignment() and supportsVisibleFederation() are true

getResourceRouteNotificationSession

ResourceRouteNotificationSession getResourceRouteNotificationSession(ResourceRouteReceiver resourceRouteReceiver,
                                                                   Proxy proxy)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the resource route notification service.

Parameters:

resourceRouteReceiver - the notification callback

proxy - a proxy

Returns:

a ResourceRouteNotificationSession

Throws:

NullArgumentException - resourceRouteReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRouteNotification() is false

Compliance:

optional - This method must be implemented if supportsResourceRouteNotification() is true.

getResourceRouteNotificationSessionForMap

ResourceRouteNotificationSession getResourceRouteNotificationSessionForMap(ResourceRouteReceiver resourceRouteReceiver,
                                                                         Id mapId,
                                                                         Proxy proxy)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

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

Parameters:

resourceRouteReceiver - the notification callback

mapId - the Id of the Map

proxy - a proxy

Returns:

a ResourceRouteNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - resourceRouteReceiver, mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRouteNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResourceRouteNotification() and supportsVisibleFederation() are true

getMyRouteSession

MyRouteSession getMyRouteSession(Proxy proxy)
                                 throws OperationFailedException

Gets the OsidSession associated with the my route service.

Parameters:

proxy - a proxy

Returns:

a MyRouteLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyRouteLookup() is false

Compliance:

optional - This method must be implemented if supportsMyRouteLookup() is true.

getMyRouteSessionForMap

MyRouteSession getMyRouteSessionForMap(Id mapId,
                                     Proxy proxy)
                                       throws NotFoundException,
                                              OperationFailedException

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

Parameters:

mapId - the Id of the map

proxy - a proxy

Returns:

a MyRouteLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyRouteLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMyRouteLookup() and supportsVisibleFederation() are true