Interface MappingRouteManager

All Superinterfaces:

AutoCloseable, Closeable, MappingRouteProfile, OsidManager, OsidManager, OsidProfile, Sourceable

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

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface MappingRouteProfile

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

Modifier and Type	Method	Description
TypeList	getRouteProgressRecordTypes()	Gets the supported RouteProgresst record types.
TypeList	getRouteRecordTypes()	Gets the supported Route record types.
TypeList	getRouteSearchRecordTypes()	Gets the supported Route search record types.
TypeList	getRouteSegmentRecordTypes()	Gets the supported RouteSegment record types.
boolean	supportsLocationRouting()	Tests if a location routing service is supported.
boolean	supportsMyLocation()	Tests if a location service is supported for the current agent.
boolean	supportsMyRoute()	Tests if a route service is supported for the current agent.
boolean	supportsResourceRoute()	Tests if a resource route service is supported.
boolean	supportsResourceRouteAssignment()	Tests if a resource route update service is supported.
boolean	supportsResourceRouteNotification()	Tests if a resource route notification service is supported.
boolean	supportsRouteAdmin()	Tests if a route administrative service is supported.
boolean	supportsRouteLookup()	Tests if looking up routes is supported.
boolean	supportsRouteMap()	Tests if a route map lookup service is supported.
boolean	supportsRouteMapAssignment()	Tests if a route map service is supported.
boolean	supportsRouteNotification()	Tests if a route notification service is supported.
boolean	supportsRouteProgressRecordType(Type routeProgressRecordType)	Tests if the given RouteProgress record type is supported.
boolean	supportsRouteQuery()	Tests if querying routes is supported.
boolean	supportsRouteRecordType(Type routeRecordType)	Tests if the given Route record type is supported.
boolean	supportsRouteSearch()	Tests if searching routes is supported.
boolean	supportsRouteSearchRecordType(Type routeSearchRecordType)	Tests if the given Route search record type is supported.
boolean	supportsRouteSegmentRecordType(Type routeSegmentRecordType)	Tests if the given RouteSegment record type is supported.
boolean	supportsRouteSmartMap()	Tests if a route 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

getRoutingSession

RoutingSession getRoutingSession()
                          throws OperationFailedException

Gets the OsidSession associated with the location routing service.

Returns:

a RoutingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRouting() is false

Compliance:

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

getRoutingSessionForMap

RoutingSession getRoutingSessionForMap(Id mapId)
                                throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a RoutingSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouting() or supportsVisibleFederation() is false

Compliance:

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

getRouteLookupSession

RouteLookupSession getRouteLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the route lookup service.

Returns:

a RouteLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteLookup() is false

Compliance:

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

getRouteLookupSessionForMap

RouteLookupSession getRouteLookupSessionForMap(Id mapId)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the map

Returns:

a RouteLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteLookup() or supportsVisibleFederation() is false

Compliance:

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

getRouteQuerySession

RouteQuerySession getRouteQuerySession()
                                throws OperationFailedException

Gets the OsidSession associated with the route query service.

Returns:

a RouteQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteQuery() is false

Compliance:

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

getRouteQuerySessionForMap

RouteQuerySession getRouteQuerySessionForMap(Id mapId)
                                      throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the map

Returns:

a RouteQuerySession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteQuery() or supportsVisibleFederation() is false

Compliance:

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

getRouteSearchSession

RouteSearchSession getRouteSearchSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the route search service.

Returns:

a RouteSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteSearch() is false

Compliance:

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

getRouteSearchSessionForMap

RouteSearchSession getRouteSearchSessionForMap(Id mapId)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a RouteSearchSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteSearch() or supportsVisibleFederation() is false

Compliance:

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

getRouteAdminSession

RouteAdminSession getRouteAdminSession()
                                throws OperationFailedException

Gets the OsidSession associated with the route administration service.

Returns:

a RouteAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteAdmin() is false

Compliance:

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

getRouteAdminSessionForMap

RouteAdminSession getRouteAdminSessionForMap(Id mapId)
                                      throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a RouteAdminSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteAdmin() or supportsVisibleFederation() is false

Compliance:

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

getRouteNotificationSession

RouteNotificationSession getRouteNotificationSession(RouteReceiver routeReceiver)
                                              throws OperationFailedException

Gets the OsidSession associated with the route notification service.

Parameters:

routeReceiver - the notification callback

Returns:

a RouteNotificationSession

Throws:

NullArgumentException - routeReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteNotification() is false

Compliance:

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

getRouteNotificationSessionForMap

RouteNotificationSession getRouteNotificationSessionForMap(RouteReceiver routeReceiver,
 Id mapId)
                                                    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

Returns:

a RouteNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - routeReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteNotification() or supportsVisibleFederation() is false

Compliance:

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

getRouteMapSession

RouteMapSession getRouteMapSession()
                            throws OperationFailedException

Gets the OsidSession to lookup route/map mappings.

Returns:

a RouteMapSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteMap() is false

Compliance:

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

getRouteMapAssignmentSession

RouteMapAssignmentSession getRouteMapAssignmentSession()
                                                throws OperationFailedException

Gets the OsidSession associated with assigning routes to maps.

Returns:

a LocationMapAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteMapAssignment() is false

Compliance:

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

getRouteSmartMapSession

RouteSmartMapSession getRouteSmartMapSession(Id mapId)
                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage route smart maps.

Parameters:

mapId - the Id of the Map

Returns:

a RouteSmartMapSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRouteSmartMap() is false

Compliance:

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

getResourceRouteSession

ResourceRouteSession getResourceRouteSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the resource route service.

Returns:

a ResourceRouteSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRoute() is false

Compliance:

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

getResourceRouteSessionForMap

ResourceRouteSession getResourceRouteSessionForMap(Id mapId)
                                            throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a ResourceRouteSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRoute() or supportsVisibleFederation() is false

Compliance:

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

getResourceRouteAssignmentSession

ResourceRouteAssignmentSession getResourceRouteAssignmentSession()
                                                          throws OperationFailedException

Gets the OsidSession associated with the resource route assignment service.

Returns:

a ResourceRouteAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRouteAssignment() is false

Compliance:

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

getResourceRouteAssignmentSessionForMap

ResourceRouteAssignmentSession getResourceRouteAssignmentSessionForMap(Id mapId)
                                                                throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the Map

Returns:

a ResourceRouteAssignmentSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRouteAssignment() or supportsVisibleFederation() is false

Compliance:

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

getResourceRouteNotificationSession

ResourceRouteNotificationSession getResourceRouteNotificationSession(ResourceRouteReceiver resourceRouteReceiver)
                                                              throws OperationFailedException

Gets the OsidSession associated with the resource route notification service.

Parameters:

resourceRouteReceiver - the notification callback

Returns:

a ResourceRouteNotificationSession

Throws:

NullArgumentException - resourceRouteReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRouteNotification() is false

Compliance:

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

getResourceRouteNotificationSessionForMap

ResourceRouteNotificationSession getResourceRouteNotificationSessionForMap(ResourceRouteReceiver resourceRouteReceiver,
 Id mapId)
                                                                    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

Returns:

a ResourceRouteNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - resourceRouteReceiver or mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceRouteNotification() or supportsVisibleFederation() is false

Compliance:

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

getMyRouteSession

MyRouteSession getMyRouteSession()
                          throws OperationFailedException

Gets the OsidSession associated with the my route service.

Returns:

a MyRouteLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMyRouteLookup() is false

Compliance:

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

getMyRouteSessionForMap

MyRouteSession getMyRouteSessionForMap(Id mapId)
                                throws NotFoundException,
OperationFailedException

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

Parameters:

mapId - the Id of the map

Returns:

a MyRouteLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyRouteLookup() or supportsVisibleFederation() is false

Compliance:

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