com.esri.arcgis.arcweb
Interface IArcWebSpatialQueryOptions

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArcWebSpatialQueryOptions

public interface IArcWebSpatialQueryOptions
extends Serializable

Provides access to members that control an ArcWeb spatial query.

Product Availability

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


Method Summary
 double getBufferDistance()
          The area in which to search for results.
 int getBufferUnits()
          The units for the buffer distance.
 String getDataSource()
          The name of the data source.
 int getDistanceUnits()
          The units used to measure the distance from the input search geometry to individual results (default is miles).
 IArcWebSearchOptions getSearchOptions()
          The parameters defining the search results.
 boolean isReturnDistance()
          Indicates if the distances are returned from the input search geometry to the individual results (default is false).
 boolean isReturnGeometry()
          Indicates if the latitude and longitude values are returned.
 void setBufferDistance(double bufferDistance)
          The area in which to search for results.
 void setBufferUnits(int distanceUnits)
          The units for the buffer distance.
 void setDataSource(String dataSource)
          The name of the data source.
 void setDistanceUnits(int distanceUnits)
          The units used to measure the distance from the input search geometry to individual results (default is miles).
 void setReturnDistance(boolean returnDistance)
          Indicates if the distances are returned from the input search geometry to the individual results (default is false).
 void setReturnGeometry(boolean returnGeometry)
          Indicates if the latitude and longitude values are returned.
 void setSearchOptionsByRef(IArcWebSearchOptions searchOptions)
          The parameters defining the search results.
 

Method Detail

getDataSource

String getDataSource()
                     throws IOException,
                            AutomationException
The name of the data source.

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.

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.

getDistanceUnits

int getDistanceUnits()
                     throws IOException,
                            AutomationException
The units used to measure the distance from the input search geometry to individual results (default is miles).

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.

setDistanceUnits

void setDistanceUnits(int distanceUnits)
                      throws IOException,
                             AutomationException
The units used to measure the distance from the input search geometry to individual results (default is miles).

Product Availability

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

Parameters:
distanceUnits - A com.esri.arcgis.arcweb.esriArcWebDistanceUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReturnDistance

boolean isReturnDistance()
                         throws IOException,
                                AutomationException
Indicates if the distances are returned from the input search geometry to the individual results (default is false).

Product Availability

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

Returns:
The returnDistance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReturnDistance

void setReturnDistance(boolean returnDistance)
                       throws IOException,
                              AutomationException
Indicates if the distances are returned from the input search geometry to the individual results (default is false).

Product Availability

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

Parameters:
returnDistance - The returnDistance (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 latitude and longitude values are returned.

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 latitude and longitude values are returned.

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.

getSearchOptions

IArcWebSearchOptions getSearchOptions()
                                      throws IOException,
                                             AutomationException
The parameters defining the search results.

Product Availability

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

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

setSearchOptionsByRef

void setSearchOptionsByRef(IArcWebSearchOptions searchOptions)
                           throws IOException,
                                  AutomationException
The parameters defining the search results.

Product Availability

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

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

getBufferDistance

double getBufferDistance()
                         throws IOException,
                                AutomationException
The area in which to search for results.

Product Availability

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

Returns:
The bufferDistance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBufferDistance

void setBufferDistance(double bufferDistance)
                       throws IOException,
                              AutomationException
The area in which to search for results.

Product Availability

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

Parameters:
bufferDistance - The bufferDistance (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBufferUnits

int getBufferUnits()
                   throws IOException,
                          AutomationException
The units for the buffer distance.

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.

setBufferUnits

void setBufferUnits(int distanceUnits)
                    throws IOException,
                           AutomationException
The units for the buffer distance.

Product Availability

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

Parameters:
distanceUnits - A com.esri.arcgis.arcweb.esriArcWebDistanceUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.