com.esri.arcgis.arcweb
Class ArcWebLocationInfo

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

public class ArcWebLocationInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebLocationInfo

The information describing a geocode request.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
ArcWebLocationInfo(Object obj)
          Construct a ArcWebLocationInfo using a reference to such an object returned from ArcGIS Engine or Server.
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 IEnumArcWebLocation getEnumArcWebLocation()
          An enumerator of places that match the input criteria.
 int getMatchType()
          The type of candidate match.
 int getTotalCount()
          The total number of results that meet the search criteria.
 int hashCode()
          the hashcode for this object
 boolean isHasMore()
          Indicates if there are more records available in the result than returned.
 
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

ArcWebLocationInfo

public ArcWebLocationInfo(Object obj)
                   throws IOException
Construct a ArcWebLocationInfo using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcWebLocationInfo.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ArcWebLocationInfo o = (ArcWebLocationInfo)obj; // will not work

ArcWebLocationInfo o = new ArcWebLocationInfo(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:
IOException - if there are interop problems ArcWebLocationInfo theArcWebLocationInfo = (ArcWebLocationInfo) obj;
Method Detail

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

isHasMore

public boolean isHasMore()
                  throws IOException,
                         AutomationException
Indicates if there are more records available in the result than returned.

Product Availability

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

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

getMatchType

public int getMatchType()
                 throws IOException,
                        AutomationException
The type of candidate match.

Product Availability

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

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

getTotalCount

public int getTotalCount()
                  throws IOException,
                         AutomationException
The total number of results that meet the search criteria.

Product Availability

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

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

getEnumArcWebLocation

public IEnumArcWebLocation getEnumArcWebLocation()
                                          throws IOException,
                                                 AutomationException
An enumerator of places that match the input criteria.

Product Availability

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

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