com.esri.arcgis.networkanalyst
Interface INALocatorLocationFieldsAgent2

All Superinterfaces:
INALocatorLocationFieldsAgent, Serializable
All Known Implementing Classes:
NALocatorLocationFieldsAgent

public interface INALocatorLocationFieldsAgent2
extends INALocatorLocationFieldsAgent, Serializable

Provides access to the field names used by the locator.

Remarks

The INALocatorLocationFieldsAgent2 interface allows you to specify a locator for finding network locations based upon known Source ID, OID, Side and Position values.

INALocatorLocationFieldsAgent2 interface also allows you to specify the name of the BLOB field that contains location ranges.

You need to call the Bind method after setting these properties before using the locator agent.

Product Availability

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


Method Summary
 String getLocationRangesFieldName()
          The NALocationRanges field name.
 void setLocationRangesFieldName(String fieldName)
          The NALocationRanges field name.
 
Methods inherited from interface com.esri.arcgis.networkanalyst.INALocatorLocationFieldsAgent
getOIDFieldName, getPositionFieldName, getSideFieldName, getSourceIDFieldName, setOIDFieldName, setPositionFieldName, setSideFieldName, setSourceIDFieldName
 

Method Detail

setLocationRangesFieldName

void setLocationRangesFieldName(String fieldName)
                                throws IOException,
                                       AutomationException
The NALocationRanges field name.

Remarks

LocationRangesFieldName specifies the name of the field which contains the location ranges BLOB field. You need to call the Bind method after setting this property before using the locator agent.

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.

getLocationRangesFieldName

String getLocationRangesFieldName()
                                  throws IOException,
                                         AutomationException
The NALocationRanges field name.

Remarks

LocationRangesFieldName specifies the name of the field which contains the location ranges BLOB field. You need to call the Bind method after setting this property before using the locator agent.

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.