com.esri.arcgis.arcweb
Interface IArcWebRouteFinder

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArcWebRouteFinder, IArcWebRouteFinderProxy

public interface IArcWebRouteFinder
extends Serializable

Provides access to members that find routes and generate driving directions between multiple locations.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

IArcWebRouteInfo	findRoute(IEnumArcWebRouteStops routeStops, IArcWebRouteFinderOptions routeFinderOptions, ITrackCancel cancelTracker) Returns route information for a given set of route stops and routing parameters.
IEnumBSTR	getLanguages(ITrackCancel cancelTracker) Gets the supported languages for the driving directions.
IEnumArcWebDataSourceInfo	getSupportedDataSources(ITrackCancel pCancelTracker) Gets the supported data sources for the route finding service.

Method Detail

getLanguages

IEnumBSTR getLanguages(ITrackCancel cancelTracker)
                       throws IOException,
                              AutomationException

Gets the supported languages for the driving directions.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findRoute

IArcWebRouteInfo findRoute(IEnumArcWebRouteStops routeStops,
                           IArcWebRouteFinderOptions routeFinderOptions,
                           ITrackCancel cancelTracker)
                           throws IOException,
                                  AutomationException

Returns route information for a given set of route stops and routing parameters.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

routeStops - A reference to a com.esri.arcgis.arcweb.IEnumArcWebRouteStops (in)

routeFinderOptions - A reference to a com.esri.arcgis.arcweb.IArcWebRouteFinderOptions (in)

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.arcweb.IArcWebRouteInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedDataSources

IEnumArcWebDataSourceInfo getSupportedDataSources(ITrackCancel pCancelTracker)
                                                  throws IOException,
                                                         AutomationException

Gets the supported data sources for the route finding service.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pCancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.arcweb.IEnumArcWebDataSourceInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.