com.esri.arcgis.arcweb
Interface IArcWebRouteFinderOptions

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArcWebRouteFinderOptions

public interface IArcWebRouteFinderOptions
extends Serializable

Provides access to members that control finding routes in ArcWeb.

Product Availability

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

Method Summary

String	getDataSource() The name of the data source to use for routing.
String	getLanguage() The language used in the route description (default is English).
IArcWebRouteDisplayOptions	getRouteDisplayOptions() The parameters for how the route is displayed on a map.
IArcWebMapImageOptions	getRouteMapOptions() The parameters for a map image of the route.
IArcWebRouteOptions	getRouteOptions() The parameters for the route.
String	getTrafficDataSource() The name of the traffic data source used to create traffic barriers.
int	getTrafficSeverity() The traffic incident severity ratings to avoid 0-4 (default is 0 which avoids all incidents).
int	getUnits() The units of the route (default is esriArcWebDistanceUnitsMiles).
boolean	isAvoidTraffic() Indicates if current traffic conditions are considered when generating a route (default is VARIANT_FALSE).
boolean	isReturnDirections() Indicates if a description of the route is returned (default is VARIANT_FALSE).
boolean	isReturnGeometry() Indicates if the geometry of the route is returned (default is VARIANT_FALSE).
boolean	isReturnMap() Indicates if map image of the route is returned (default is VARIANT_FALSE).
boolean	isReturnTurnByTurnMaps() Indicates if turn-by-turn maps are returned (default is VARIANT_FALSE).
void	setAvoidTraffic(boolean avoidTraffic) Indicates if current traffic conditions are considered when generating a route (default is VARIANT_FALSE).
void	setDataSource(String dataSource) The name of the data source to use for routing.
void	setLanguage(String language) The language used in the route description (default is English).
void	setReturnDirections(boolean returnDirections) Indicates if a description of the route is returned (default is VARIANT_FALSE).
void	setReturnGeometry(boolean returnGeometry) Indicates if the geometry of the route is returned (default is VARIANT_FALSE).
void	setReturnMap(boolean pVal) Indicates if map image of the route is returned (default is VARIANT_FALSE).
void	setReturnTurnByTurnMaps(boolean pVal) Indicates if turn-by-turn maps are returned (default is VARIANT_FALSE).
void	setRouteDisplayOptionsByRef(IArcWebRouteDisplayOptions routeDisplayOptions) The parameters for how the route is displayed on a map.
void	setRouteMapOptionsByRef(IArcWebMapImageOptions mapOptions) The parameters for a map image of the route.
void	setRouteOptionsByRef(IArcWebRouteOptions routeOptions) The parameters for the route.
void	setTrafficDataSource(String pVal) The name of the traffic data source used to create traffic barriers.
void	setTrafficSeverity(int pVal) The traffic incident severity ratings to avoid 0-4 (default is 0 which avoids all incidents).
void	setUnits(int pVal) The units of the route (default is esriArcWebDistanceUnitsMiles).

Method Detail

isAvoidTraffic

boolean isAvoidTraffic()
                       throws IOException,
                              AutomationException

Indicates if current traffic conditions are considered when generating a route (default is VARIANT_FALSE).

Product Availability

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

Returns:

The avoidTraffic

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAvoidTraffic

void setAvoidTraffic(boolean avoidTraffic)
                     throws IOException,
                            AutomationException

Indicates if current traffic conditions are considered when generating a route (default is VARIANT_FALSE).

Product Availability

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

Parameters:

avoidTraffic - The avoidTraffic (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnDirections

boolean isReturnDirections()
                           throws IOException,
                                  AutomationException

Indicates if a description of the route is returned (default is VARIANT_FALSE).

Product Availability

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

Returns:

The returnDirections

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnDirections

void setReturnDirections(boolean returnDirections)
                         throws IOException,
                                AutomationException

Indicates if a description of the route is returned (default is VARIANT_FALSE).

Product Availability

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

Parameters:

returnDirections - The returnDirections (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnGeometry

boolean isReturnGeometry()
                         throws IOException,
                                AutomationException

Indicates if the geometry of the route is returned (default is VARIANT_FALSE).

Product Availability

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

Returns:

The returnGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnGeometry

void setReturnGeometry(boolean returnGeometry)
                       throws IOException,
                              AutomationException

Indicates if the geometry of the route is returned (default is VARIANT_FALSE).

Product Availability

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

Parameters:

returnGeometry - The returnGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDataSource

String getDataSource()
                     throws IOException,
                            AutomationException

The name of the data source to use for routing.

Product Availability

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

Returns:

The dataSource

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataSource

void setDataSource(String dataSource)
                   throws IOException,
                          AutomationException

The name of the data source to use for routing.

Product Availability

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

Parameters:

dataSource - The dataSource (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLanguage

String getLanguage()
                   throws IOException,
                          AutomationException

The language used in the route description (default is English).

Product Availability

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

Returns:

The language

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLanguage

void setLanguage(String language)
                 throws IOException,
                        AutomationException

The language used in the route description (default is English).

Product Availability

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

Parameters:

language - The language (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnMap

boolean isReturnMap()
                    throws IOException,
                           AutomationException

Indicates if map image of the route is returned (default is VARIANT_FALSE).

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnMap

void setReturnMap(boolean pVal)
                  throws IOException,
                         AutomationException

Indicates if map image of the route is returned (default is VARIANT_FALSE).

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReturnTurnByTurnMaps

boolean isReturnTurnByTurnMaps()
                               throws IOException,
                                      AutomationException

Indicates if turn-by-turn maps are returned (default is VARIANT_FALSE).

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReturnTurnByTurnMaps

void setReturnTurnByTurnMaps(boolean pVal)
                             throws IOException,
                                    AutomationException

Indicates if turn-by-turn maps are returned (default is VARIANT_FALSE).

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrafficDataSource

String getTrafficDataSource()
                            throws IOException,
                                   AutomationException

The name of the traffic data source used to create traffic barriers.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTrafficDataSource

void setTrafficDataSource(String pVal)
                          throws IOException,
                                 AutomationException

The name of the traffic data source used to create traffic barriers.

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTrafficSeverity

int getTrafficSeverity()
                       throws IOException,
                              AutomationException

The traffic incident severity ratings to avoid 0-4 (default is 0 which avoids all incidents).

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTrafficSeverity

void setTrafficSeverity(int pVal)
                        throws IOException,
                               AutomationException

The traffic incident severity ratings to avoid 0-4 (default is 0 which avoids all incidents).

Product Availability

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

Parameters:

pVal - The pVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUnits

int getUnits()
             throws IOException,
                    AutomationException

The units of the route (default is esriArcWebDistanceUnitsMiles).

Product Availability

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

Returns:

A com.esri.arcgis.arcweb.esriArcWebDistanceUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUnits

void setUnits(int pVal)
              throws IOException,
                     AutomationException

The units of the route (default is esriArcWebDistanceUnitsMiles).

Product Availability

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

Parameters:

pVal - A com.esri.arcgis.arcweb.esriArcWebDistanceUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteOptions

IArcWebRouteOptions getRouteOptions()
                                    throws IOException,
                                           AutomationException

The parameters for the route.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteOptionsByRef

void setRouteOptionsByRef(IArcWebRouteOptions routeOptions)
                          throws IOException,
                                 AutomationException

The parameters for the route.

Product Availability

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

Parameters:

routeOptions - A reference to a com.esri.arcgis.arcweb.IArcWebRouteOptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteDisplayOptions

IArcWebRouteDisplayOptions getRouteDisplayOptions()
                                                  throws IOException,
                                                         AutomationException

The parameters for how the route is displayed on a map.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteDisplayOptionsByRef

void setRouteDisplayOptionsByRef(IArcWebRouteDisplayOptions routeDisplayOptions)
                                 throws IOException,
                                        AutomationException

The parameters for how the route is displayed on a map.

Product Availability

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

Parameters:

routeDisplayOptions - A reference to a com.esri.arcgis.arcweb.IArcWebRouteDisplayOptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteMapOptions

IArcWebMapImageOptions getRouteMapOptions()
                                          throws IOException,
                                                 AutomationException

The parameters for a map image of the route.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteMapOptionsByRef

void setRouteMapOptionsByRef(IArcWebMapImageOptions mapOptions)
                             throws IOException,
                                    AutomationException

The parameters for a map image of the route.

Product Availability

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

Parameters:

mapOptions - A reference to a com.esri.arcgis.arcweb.IArcWebMapImageOptions (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.