com.esri.arcgis.geodatabase
Interface IDirectionsLandmarkSource

All Superinterfaces:

Serializable

All Known Implementing Classes:

DirectionsLandmarkSource

public interface IDirectionsLandmarkSource
extends Serializable

.

Product Availability

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

Method Summary

String	getFeatureClassName() The name of the landmarks feature class.
String	getLabelFieldName() The name of the landmarks feature class field which is used to access the landmark display name.
String	getLevelFieldName() The name of the landmarks feature class field which is used to access the landmark Z-level value.
double	getSearchTolerance() The search tolerance value used to find landmarks along the route using spatial search.
int	getSearchToleranceUnits() The search tolerance value unit type.
boolean	isUseSpatialSearch() Indicates if spatial search should be used to locate landmarks along the route.
void	setFeatureClassName(String name) The name of the landmarks feature class.
void	setLabelFieldName(String name) The name of the landmarks feature class field which is used to access the landmark display name.
void	setLevelFieldName(String name) The name of the landmarks feature class field which is used to access the landmark Z-level value.
void	setSearchTolerance(double tolerance) The search tolerance value used to find landmarks along the route using spatial search.
void	setSearchToleranceUnits(int units) The search tolerance value unit type.
void	setUseSpatialSearch(boolean useSearch) Indicates if spatial search should be used to locate landmarks along the route.

Method Detail

getFeatureClassName

String getFeatureClassName()
                           throws IOException,
                                  AutomationException

The name of the landmarks feature class.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFeatureClassName

void setFeatureClassName(String name)
                         throws IOException,
                                AutomationException

The name of the landmarks feature class.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelFieldName

String getLabelFieldName()
                         throws IOException,
                                AutomationException

The name of the landmarks feature class field which is used to access the landmark display name.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelFieldName

void setLabelFieldName(String name)
                       throws IOException,
                              AutomationException

The name of the landmarks feature class field which is used to access the landmark display name.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLevelFieldName

String getLevelFieldName()
                         throws IOException,
                                AutomationException

The name of the landmarks feature class field which is used to access the landmark Z-level value.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLevelFieldName

void setLevelFieldName(String name)
                       throws IOException,
                              AutomationException

The name of the landmarks feature class field which is used to access the landmark Z-level value.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchTolerance

double getSearchTolerance()
                          throws IOException,
                                 AutomationException

The search tolerance value used to find landmarks along the route using spatial search.

Product Availability

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

Returns:

The tolerance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchTolerance

void setSearchTolerance(double tolerance)
                        throws IOException,
                               AutomationException

The search tolerance value used to find landmarks along the route using spatial search.

Product Availability

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

Parameters:

tolerance - The tolerance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchToleranceUnits

int getSearchToleranceUnits()
                            throws IOException,
                                   AutomationException

The search tolerance value unit type.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchToleranceUnits

void setSearchToleranceUnits(int units)
                             throws IOException,
                                    AutomationException

The search tolerance value unit type.

Product Availability

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

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseSpatialSearch

boolean isUseSpatialSearch()
                           throws IOException,
                                  AutomationException

Indicates if spatial search should be used to locate landmarks along the route.

Product Availability

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

Returns:

The useSearch

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseSpatialSearch

void setUseSpatialSearch(boolean useSearch)
                         throws IOException,
                                AutomationException

Indicates if spatial search should be used to locate landmarks along the route.

Product Availability

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

Parameters:

useSearch - The useSearch (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.