com.esri.arcgis.geodatabase
Interface IRouteEventProperties

All Superinterfaces:

Serializable

All Known Subinterfaces:

IRouteEventProperties2

All Known Implementing Classes:

RouteMeasureLineProperties, RouteMeasurePointProperties

public interface IRouteEventProperties
extends Serializable

Provides access to the properties of an event table.

Superseded By

IRouteEventProperties2

Product Availability

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

Method Summary

int	getEventMeasureUnit() The units of the event measure(s).
String	getEventRouteIDFieldName() The route identifier field name.
String	getLateralOffsetFieldName() The lateral offset field name.
void	getSettingError() The state of the object (see if all the required field names have been set).
boolean	isALineEvent() Is a line event.
void	setEventMeasureUnit(int units) The units of the event measure(s).
void	setEventRouteIDFieldName(String fieldName) The route identifier field name.
void	setLateralOffsetFieldName(String fieldName) The lateral offset field name.

Method Detail

setEventRouteIDFieldName

void setEventRouteIDFieldName(String fieldName)
                              throws IOException,
                                     AutomationException

The route identifier field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEventRouteIDFieldName

String getEventRouteIDFieldName()
                                throws IOException,
                                       AutomationException

The route identifier field name.

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.

setEventMeasureUnit

void setEventMeasureUnit(int units)
                         throws IOException,
                                AutomationException

The units of the event measure(s).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

getEventMeasureUnit

int getEventMeasureUnit()
                        throws IOException,
                               AutomationException

The units of the event measure(s).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLateralOffsetFieldName

void setLateralOffsetFieldName(String fieldName)
                               throws IOException,
                                      AutomationException

The lateral offset field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLateralOffsetFieldName

String getLateralOffsetFieldName()
                                 throws IOException,
                                        AutomationException

The lateral offset field name.

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.

isALineEvent

boolean isALineEvent()
                     throws IOException,
                            AutomationException

Is a line event.

Product Availability

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

Returns:

The lineEvent

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSettingError

void getSettingError()
                     throws IOException,
                            AutomationException

The state of the object (see if all the required field names have been set).

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.