com.esri.arcgis.location
Interface IRouteLayerExtension

All Superinterfaces:

Serializable

All Known Implementing Classes:

RouteLayerExtension

public interface IRouteLayerExtension
extends Serializable

Provides access to the route layer extension.

Remarks

The IRouteLayerExtension interface is used for route layers in ArcMap to get and set the route layers route identifier, RouteIDFieldName.

Product Availability

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

Method Summary

String	getRouteIDFieldName() The route id field name.
IRouteLocatorName	getRouteLocatorName(ILayer layer) The route locator name.
void	setRouteIDFieldName(ILayer layer, String fieldName) Set the route id field name.

Method Detail

getRouteLocatorName

IRouteLocatorName getRouteLocatorName(ILayer layer)
                                      throws IOException,
                                             AutomationException

The route locator name.

Product Availability

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

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IRouteLocatorName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRouteIDFieldName

String getRouteIDFieldName()
                           throws IOException,
                                  AutomationException

The route id field name.

Remarks

This is used to get the route identifer (RouteIDFieldName) from the IRouteLocatorName interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRouteIDFieldName

void setRouteIDFieldName(ILayer layer,
                         String fieldName)
                         throws IOException,
                                AutomationException

Set the route id field name.

Remarks

This sets the RouteIDFieldName for the route layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.