com.esri.arcgis.arcweb
Class ArcWebRouteFinderOptions

java.lang.Object
  extended by com.esri.arcgis.arcweb.ArcWebRouteFinderOptions
All Implemented Interfaces:
IArcWebRouteFinderOptions, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArcWebRouteFinderOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebRouteFinderOptions

A set of parameters used in finding a route.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
ArcWebRouteFinderOptions()
          Constructs a ArcWebRouteFinderOptions using ArcGIS Engine.
ArcWebRouteFinderOptions(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebRouteFinderOptions theArcWebRouteFinderOptions = (ArcWebRouteFinderOptions) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 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).
 int hashCode()
          the hashcode for this object
 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).
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

ArcWebRouteFinderOptions

public ArcWebRouteFinderOptions()
                         throws IOException,
                                UnknownHostException
Constructs a ArcWebRouteFinderOptions using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

ArcWebRouteFinderOptions

public ArcWebRouteFinderOptions(Object obj)
                         throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebRouteFinderOptions theArcWebRouteFinderOptions = (ArcWebRouteFinderOptions) obj;

Construct a ArcWebRouteFinderOptions using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcWebRouteFinderOptions.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

isAvoidTraffic

public 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.

Specified by:
isAvoidTraffic in interface IArcWebRouteFinderOptions
Returns:
The avoidTraffic
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAvoidTraffic

public 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.

Specified by:
setAvoidTraffic in interface IArcWebRouteFinderOptions
Parameters:
avoidTraffic - The avoidTraffic (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReturnDirections

public 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.

Specified by:
isReturnDirections in interface IArcWebRouteFinderOptions
Returns:
The returnDirections
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReturnDirections

public 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.

Specified by:
setReturnDirections in interface IArcWebRouteFinderOptions
Parameters:
returnDirections - The returnDirections (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReturnGeometry

public 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.

Specified by:
isReturnGeometry in interface IArcWebRouteFinderOptions
Returns:
The returnGeometry
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReturnGeometry

public 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.

Specified by:
setReturnGeometry in interface IArcWebRouteFinderOptions
Parameters:
returnGeometry - The returnGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDataSource

public 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.

Specified by:
getDataSource in interface IArcWebRouteFinderOptions
Returns:
The dataSource
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataSource

public 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.

Specified by:
setDataSource in interface IArcWebRouteFinderOptions
Parameters:
dataSource - The dataSource (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLanguage

public 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.

Specified by:
getLanguage in interface IArcWebRouteFinderOptions
Returns:
The language
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLanguage

public 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.

Specified by:
setLanguage in interface IArcWebRouteFinderOptions
Parameters:
language - The language (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReturnMap

public 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.

Specified by:
isReturnMap in interface IArcWebRouteFinderOptions
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReturnMap

public 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.

Specified by:
setReturnMap in interface IArcWebRouteFinderOptions
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReturnTurnByTurnMaps

public 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.

Specified by:
isReturnTurnByTurnMaps in interface IArcWebRouteFinderOptions
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReturnTurnByTurnMaps

public 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.

Specified by:
setReturnTurnByTurnMaps in interface IArcWebRouteFinderOptions
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrafficDataSource

public 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.

Specified by:
getTrafficDataSource in interface IArcWebRouteFinderOptions
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrafficDataSource

public 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.

Specified by:
setTrafficDataSource in interface IArcWebRouteFinderOptions
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTrafficSeverity

public 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.

Specified by:
getTrafficSeverity in interface IArcWebRouteFinderOptions
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTrafficSeverity

public 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.

Specified by:
setTrafficSeverity in interface IArcWebRouteFinderOptions
Parameters:
pVal - The pVal (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnits

public int getUnits()
             throws IOException,
                    AutomationException
The units of the route (default is esriArcWebDistanceUnitsMiles).

Product Availability

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

Specified by:
getUnits in interface IArcWebRouteFinderOptions
Returns:
A com.esri.arcgis.arcweb.esriArcWebDistanceUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUnits

public 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.

Specified by:
setUnits in interface IArcWebRouteFinderOptions
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

public IArcWebRouteOptions getRouteOptions()
                                    throws IOException,
                                           AutomationException
The parameters for the route.

Product Availability

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

Specified by:
getRouteOptions in interface IArcWebRouteFinderOptions
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

public void setRouteOptionsByRef(IArcWebRouteOptions routeOptions)
                          throws IOException,
                                 AutomationException
The parameters for the route.

Product Availability

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

Specified by:
setRouteOptionsByRef in interface IArcWebRouteFinderOptions
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

public 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.

Specified by:
getRouteDisplayOptions in interface IArcWebRouteFinderOptions
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

public 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.

Specified by:
setRouteDisplayOptionsByRef in interface IArcWebRouteFinderOptions
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

public 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.

Specified by:
getRouteMapOptions in interface IArcWebRouteFinderOptions
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

public 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.

Specified by:
setRouteMapOptionsByRef in interface IArcWebRouteFinderOptions
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.