com.esri.arcgis.arcweb
Class IArcWebRouteInfoProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.arcweb.IArcWebRouteInfoProxy
All Implemented Interfaces:
IArcWebRouteInfo, Externalizable, Serializable

public class IArcWebRouteInfoProxy
extends com.esri.arcgis.interop.Dispatch
implements IArcWebRouteInfo, Serializable

Provides access to members that contain information about an ArcWebRoute.

Product Availability

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

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IArcWebRouteInfoProxy()
           
  IArcWebRouteInfoProxy(Object obj)
           
protected IArcWebRouteInfoProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 String getDescriptiveDistance()
          A description of the length of the route.
 String getDescriptiveTime()
          A description of the estimated time the route takes to drive.
 IEnumArcWebDirections getDirections()
          An enumeration of the ArcWebDirections.
 double getDistance()
          The total length of the route.
 int getDistanceUnits()
          The units of the route distance.
 IEnvelope getExtent()
          The extent of the route.
 IPicture getImage()
          The picture of the route.
 IPolyline getPath()
          The geometry of the route.
 double getTime()
          The estimated number of minutes the route takes to drive.
 IEnumArcWebTurnByTurnMaps getTurnByTurnMaps()
          An enumeration of the ArcWebTurnByTurnMaps.
 void readExternal(ObjectInput in)
           
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IArcWebRouteInfoProxy

public IArcWebRouteInfoProxy()

IArcWebRouteInfoProxy

public IArcWebRouteInfoProxy(Object obj)
                      throws IOException
Throws:
IOException

IArcWebRouteInfoProxy

protected IArcWebRouteInfoProxy(Object obj,
                                String iid)
                         throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getPath

public IPolyline getPath()
                  throws IOException,
                         AutomationException
The geometry of the route.

Product Availability

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

Specified by:
getPath in interface IArcWebRouteInfo
Returns:
A reference to a com.esri.arcgis.geometry.IPolyline
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDirections

public IEnumArcWebDirections getDirections()
                                    throws IOException,
                                           AutomationException
An enumeration of the ArcWebDirections.

Product Availability

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

Specified by:
getDirections in interface IArcWebRouteInfo
Returns:
A reference to a com.esri.arcgis.arcweb.IEnumArcWebDirections
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTurnByTurnMaps

public IEnumArcWebTurnByTurnMaps getTurnByTurnMaps()
                                            throws IOException,
                                                   AutomationException
An enumeration of the ArcWebTurnByTurnMaps.

Product Availability

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

Specified by:
getTurnByTurnMaps in interface IArcWebRouteInfo
Returns:
A reference to a com.esri.arcgis.arcweb.IEnumArcWebTurnByTurnMaps
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getImage

public IPicture getImage()
                  throws IOException,
                         AutomationException
The picture of the route.

Product Availability

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

Specified by:
getImage in interface IArcWebRouteInfo
Returns:
A reference to a com.esri.arcgis.support.ms.stdole.IPicture
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDistanceUnits

public int getDistanceUnits()
                     throws IOException,
                            AutomationException
The units of the route distance.

Product Availability

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

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

getDistance

public double getDistance()
                   throws IOException,
                          AutomationException
The total length of the route.

Product Availability

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

Specified by:
getDistance in interface IArcWebRouteInfo
Returns:
The distance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTime

public double getTime()
               throws IOException,
                      AutomationException
The estimated number of minutes the route takes to drive.

Product Availability

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

Specified by:
getTime in interface IArcWebRouteInfo
Returns:
The time
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The extent of the route.

Product Availability

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

Specified by:
getExtent in interface IArcWebRouteInfo
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescriptiveDistance

public String getDescriptiveDistance()
                              throws IOException,
                                     AutomationException
A description of the length of the route.

Product Availability

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

Specified by:
getDescriptiveDistance in interface IArcWebRouteInfo
Returns:
The descriptiveDistance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescriptiveTime

public String getDescriptiveTime()
                          throws IOException,
                                 AutomationException
A description of the estimated time the route takes to drive.

Product Availability

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

Specified by:
getDescriptiveTime in interface IArcWebRouteInfo
Returns:
The descriptiveTime
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException