com.esri.arcgis.arcweb
Interface IArcWebPlaceFinderOptions

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArcWebPlaceFinderOptions, IArcWebPlaceFinderOptionsProxy

public interface IArcWebPlaceFinderOptions
extends Serializable

Provides access to members that control finding places.

Product Availability

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


Method Summary
 int getCount()
          The number of matching records to return (default is 10).
 String getDataSource()
          The name of the data source used for finding a place (default is ArcWeb:ESRI.Gazetteer.World).
 int getFilterCountry()
          The country to search (default is esriArcWebCountryAll).
 IEnvelope getFilterExtent()
          The geographic area to search (null means no area restrictions).
 String getFilterType()
          The type of place to search (null returns all types).
 int getSearchType()
          The type of search to perform (default is esriArcWebSearchTypeStartsWith).
 int getStartIndex()
          The first matching record number to return (default is 0).
 void setCount(int count)
          The number of matching records to return (default is 10).
 void setDataSource(String dataSource)
          The name of the data source used for finding a place (default is ArcWeb:ESRI.Gazetteer.World).
 void setFilterCountry(int filterCountry)
          The country to search (default is esriArcWebCountryAll).
 void setFilterExtentByRef(IEnvelope filterExtent)
          The geographic area to search (null means no area restrictions).
 void setFilterType(String filterType)
          The type of place to search (null returns all types).
 void setSearchType(int searchType)
          The type of search to perform (default is esriArcWebSearchTypeStartsWith).
 void setStartIndex(int startIndex)
          The first matching record number to return (default is 0).
 

Method Detail

getDataSource

String getDataSource()
                     throws IOException,
                            AutomationException
The name of the data source used for finding a place (default is ArcWeb:ESRI.Gazetteer.World).

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 used for finding a place (default is ArcWeb:ESRI.Gazetteer.World).

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.

getFilterCountry

int getFilterCountry()
                     throws IOException,
                            AutomationException
The country to search (default is esriArcWebCountryAll).

Product Availability

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

Returns:
A com.esri.arcgis.arcweb.esriArcWebCountry constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFilterCountry

void setFilterCountry(int filterCountry)
                      throws IOException,
                             AutomationException
The country to search (default is esriArcWebCountryAll).

Product Availability

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

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

getFilterExtent

IEnvelope getFilterExtent()
                          throws IOException,
                                 AutomationException
The geographic area to search (null means no area restrictions).

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.

setFilterExtentByRef

void setFilterExtentByRef(IEnvelope filterExtent)
                          throws IOException,
                                 AutomationException
The geographic area to search (null means no area restrictions).

Product Availability

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

Parameters:
filterExtent - 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.

getFilterType

String getFilterType()
                     throws IOException,
                            AutomationException
The type of place to search (null returns all types).

Product Availability

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

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

setFilterType

void setFilterType(String filterType)
                   throws IOException,
                          AutomationException
The type of place to search (null returns all types).

Product Availability

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

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

getCount

int getCount()
             throws IOException,
                    AutomationException
The number of matching records to return (default is 10).

Product Availability

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

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

setCount

void setCount(int count)
              throws IOException,
                     AutomationException
The number of matching records to return (default is 10).

Product Availability

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

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

getStartIndex

int getStartIndex()
                  throws IOException,
                         AutomationException
The first matching record number to return (default is 0).

Product Availability

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

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

setStartIndex

void setStartIndex(int startIndex)
                   throws IOException,
                          AutomationException
The first matching record number to return (default is 0).

Product Availability

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

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

getSearchType

int getSearchType()
                  throws IOException,
                         AutomationException
The type of search to perform (default is esriArcWebSearchTypeStartsWith).

Product Availability

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

Returns:
A com.esri.arcgis.arcweb.esriArcWebSearchType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSearchType

void setSearchType(int searchType)
                   throws IOException,
                          AutomationException
The type of search to perform (default is esriArcWebSearchTypeStartsWith).

Product Availability

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

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