com.esri.arcgis.arcweb
Interface IArcWebAddressFinderOptions

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArcWebAddressFinderOptions

public interface IArcWebAddressFinderOptions
extends Serializable

Provides access to members that control the ArcWebAddressFinder.

Product Availability

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

Method Summary

int	getCount() The number of records that are returned in the results (default is 20).
String	getDataSource() The name of the data source to use for geocoding.
int	getSnapType() The snap type to be used with the method FindAddressByPoint.
int	getStartIndex() The number of records to skip in the query.
boolean	isExtendedPostalCode() Indicates if extended postal codes (for example, zip + 4) are returned (default is VARIANT_FALSE).
boolean	isPartialAddress() Indicates if partial addresses are returned when not enough address information exists in the request (default is VARIANT_FALSE).
void	setCount(int count) The number of records that are returned in the results (default is 20).
void	setDataSource(String dataSource) The name of the data source to use for geocoding.
void	setExtendedPostalCode(boolean extendedPostalCode) Indicates if extended postal codes (for example, zip + 4) are returned (default is VARIANT_FALSE).
void	setPartialAddress(boolean partialAddress) Indicates if partial addresses are returned when not enough address information exists in the request (default is VARIANT_FALSE).
void	setSnapType(int snapType) The snap type to be used with the method FindAddressByPoint.
void	setStartIndex(int startIndex) The number of records to skip in the query.

Method Detail

getDataSource

String getDataSource()
                     throws IOException,
                            AutomationException

The name of the data source to use for geocoding.

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 to use for geocoding.

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.

isExtendedPostalCode

boolean isExtendedPostalCode()
                             throws IOException,
                                    AutomationException

Indicates if extended postal codes (for example, zip + 4) are returned (default is VARIANT_FALSE).

Product Availability

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

Returns:

The extendedPostalCode

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendedPostalCode

void setExtendedPostalCode(boolean extendedPostalCode)
                           throws IOException,
                                  AutomationException

Indicates if extended postal codes (for example, zip + 4) are returned (default is VARIANT_FALSE).

Product Availability

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

Parameters:

extendedPostalCode - The extendedPostalCode (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPartialAddress

boolean isPartialAddress()
                         throws IOException,
                                AutomationException

Indicates if partial addresses are returned when not enough address information exists in the request (default is VARIANT_FALSE).

Product Availability

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

Returns:

The partialAddress

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPartialAddress

void setPartialAddress(boolean partialAddress)
                       throws IOException,
                              AutomationException

Indicates if partial addresses are returned when not enough address information exists in the request (default is VARIANT_FALSE).

Product Availability

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

Parameters:

partialAddress - The partialAddress (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 records that are returned in the results (default is 20).

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 records that are returned in the results (default is 20).

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 number of records to skip in the query. To get records 11-15, set startIndex to "10".

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 number of records to skip in the query. To get records 11-15, set startIndex to "10".

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.

getSnapType

int getSnapType()
                throws IOException,
                       AutomationException

The snap type to be used with the method FindAddressByPoint.

Product Availability

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

Returns:

A com.esri.arcgis.arcweb.esriArcWebSnapType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapType

void setSnapType(int snapType)
                 throws IOException,
                        AutomationException

The snap type to be used with the method FindAddressByPoint.

Product Availability

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

Parameters:

snapType - A com.esri.arcgis.arcweb.esriArcWebSnapType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.