com.esri.arcgis.networkanalyst
Interface INALocatorLocationFieldsAgent

All Superinterfaces:

Serializable

All Known Subinterfaces:

INALocatorLocationFieldsAgent2

All Known Implementing Classes:

NALocatorLocationFieldsAgent

public interface INALocatorLocationFieldsAgent
extends Serializable

Provides access to the field names used by the locator.

Remarks

INALocatorLocationFieldsAgent has been superseded by INALocatorLocationFieldsAgent2.

Product Availability

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

Method Summary

String	getOIDFieldName() The OID field name.
String	getPositionFieldName() The position field name.
String	getSideFieldName() The side field name.
String	getSourceIDFieldName() The source ID field name.
void	setOIDFieldName(String fieldName) The OID field name.
void	setPositionFieldName(String fieldName) The position field name.
void	setSideFieldName(String fieldName) The side field name.
void	setSourceIDFieldName(String fieldName) The source ID field name.

Method Detail

setSourceIDFieldName

void setSourceIDFieldName(String fieldName)
                          throws IOException,
                                 AutomationException

The source ID field name.

Remarks

SourceIDFieldName specifies the field which contains the Source ID values. Each feature class added to a network dataset gets assinged a unique Source ID.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceIDFieldName

String getSourceIDFieldName()
                            throws IOException,
                                   AutomationException

The source ID field name.

Remarks

SourceIDFieldName specifies the field which contains the Source ID values. Each feature class added to a network dataset gets assinged a unique Source ID.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOIDFieldName

void setOIDFieldName(String fieldName)
                     throws IOException,
                            AutomationException

The OID field name.

Remarks

OIDFieldName specifies the field which contains the OID values.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

String getOIDFieldName()
                       throws IOException,
                              AutomationException

The OID field name.

Remarks

OIDFieldName specifies the field which contains the OID values.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPositionFieldName

void setPositionFieldName(String fieldName)
                          throws IOException,
                                 AutomationException

The position field name.

Remarks

PositionFieldName specifies the field which contains the position values. Position values range from 0.0 to 1.0 along the feature.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPositionFieldName

String getPositionFieldName()
                            throws IOException,
                                   AutomationException

The position field name.

Remarks

PositionFieldName specifies the field which contains the position values. Position values range from 0.0 to 1.0 along the feature.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSideFieldName

void setSideFieldName(String fieldName)
                      throws IOException,
                             AutomationException

The side field name.

Remarks

SideFieldName specifies the field which contains the side of street values.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSideFieldName

String getSideFieldName()
                        throws IOException,
                               AutomationException

The side field name.

Remarks

SideFieldName specifies the field which contains the side of street values.

Product Availability

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

Returns:

The fieldName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.