com.esri.arcgis.arcweb
Interface IArcWebLocation

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArcWebLocation, IArcWebLocationProxy

public interface IArcWebLocation
extends Serializable

Provides access to members that describe a location.

Product Availability

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


Method Summary
 IArcWebAddress getAddress()
          The address or intersection of the place.
 String getDescription1()
          The scrubbed address (e.g., 380 New York St.
 String getDescription2()
          The short description of the place (e.g., Redlands).
 IEnvelope getEnvelope()
          The bounding extent of the place.
 String getPlaceType()
          A letter indicating the type of place.
 IPoint getPoint()
          The x,y coordinates and the coordinate system of the place.
 double getScore()
          A number from 1 to 20 indicating the likelihood of a match to the place, with 1 being the most likely and 20 being the least likely.
 void setAddress(IArcWebAddress address)
          The address or intersection of the place.
 void setDescription1(String pVal)
          The scrubbed address (e.g., 380 New York St.
 void setDescription2(String pVal)
          The short description of the place (e.g., Redlands).
 void setEnvelopeByRef(IEnvelope pVal)
          The bounding extent of the place.
 void setPlaceType(String pVal)
          A letter indicating the type of place.
 void setPointByRef(IPoint pVal)
          The x,y coordinates and the coordinate system of the place.
 void setScore(double pVal)
          A number from 1 to 20 indicating the likelihood of a match to the place, with 1 being the most likely and 20 being the least likely.
 

Method Detail

getAddress

IArcWebAddress getAddress()
                          throws IOException,
                                 AutomationException
The address or intersection of the place.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.arcweb.IArcWebAddress
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAddress

void setAddress(IArcWebAddress address)
                throws IOException,
                       AutomationException
The address or intersection of the place.

Product Availability

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

Parameters:
address - A reference to a com.esri.arcgis.arcweb.IArcWebAddress (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription1

String getDescription1()
                       throws IOException,
                              AutomationException
The scrubbed address (e.g., 380 New York St. Redlands, CA 92373) or long description of the place (e.g., Redlands, California, United States).

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.

setDescription1

void setDescription1(String pVal)
                     throws IOException,
                            AutomationException
The scrubbed address (e.g., 380 New York St. Redlands, CA 92373) or long description of the place (e.g., Redlands, California, United States).

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.

getDescription2

String getDescription2()
                       throws IOException,
                              AutomationException
The short description of the place (e.g., Redlands).

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.

setDescription2

void setDescription2(String pVal)
                     throws IOException,
                            AutomationException
The short description of the place (e.g., Redlands).

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.

getEnvelope

IEnvelope getEnvelope()
                      throws IOException,
                             AutomationException
The bounding extent of the place.

Product Availability

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

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.

setEnvelopeByRef

void setEnvelopeByRef(IEnvelope pVal)
                      throws IOException,
                             AutomationException
The bounding extent of the place.

Product Availability

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

Parameters:
pVal - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPoint

IPoint getPoint()
                throws IOException,
                       AutomationException
The x,y coordinates and the coordinate system of the place.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPointByRef

void setPointByRef(IPoint pVal)
                   throws IOException,
                          AutomationException
The x,y coordinates and the coordinate system of the place.

Product Availability

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

Parameters:
pVal - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getScore

double getScore()
                throws IOException,
                       AutomationException
A number from 1 to 20 indicating the likelihood of a match to the place, with 1 being the most likely and 20 being the least likely.

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.

setScore

void setScore(double pVal)
              throws IOException,
                     AutomationException
A number from 1 to 20 indicating the likelihood of a match to the place, with 1 being the most likely and 20 being the least likely.

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.

getPlaceType

String getPlaceType()
                    throws IOException,
                           AutomationException
A letter indicating the type of place.

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.

setPlaceType

void setPlaceType(String pVal)
                  throws IOException,
                         AutomationException
A letter indicating the type of place.

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.