com.esri.arcgis.location
Interface IReferenceDataField

All Superinterfaces:
Serializable
All Known Subinterfaces:
IReferenceDataFieldEdit
All Known Implementing Classes:
IReferenceDataFieldEditProxy, IReferenceDataFieldProxy, ReferenceDataField

public interface IReferenceDataField
extends Serializable

Provides access to members for inspecting a reference data field.

When To Use

Use the IReferenceDataField interface to get information about the Field in the ReferenceDataTable used by the locator.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
ReferenceDataIndex, IReferenceDataFieldEdit, ReferenceDataFieldsEnumerator, ReferenceDataTableEnumerator, IReferenceDataField, IReferenceDataTableEdit, ESRIFDOAddressLocator, IReferenceDataFile.getPathName(), StreetMapAddressLocator, IEnumReferenceDataField, IReferenceDataFile, IReferenceDataTable, IReferenceDataTables, IReferenceDataTables.getTables(), ReferenceDataField, IReferenceDataFile.getFilters(), IEnumReferenceDataTable, ReferenceDataTable, IAddressGeocoding.validate(), ReferenceDataIndexEnumerator, IEnumReferenceDataIndex

Method Summary
 String getDisplayName()
          Name for the reference data field to display in the user interface.
 String getInternalName()
          Internal name for the reference data field.
 String getName()
          Name of the field in the reference data table.
 boolean isObjectID()
          Indicates if the field is the ObjectID field.
 boolean isRequired()
          Indicates whether the field is a required by the locator.
 boolean isShape()
          Indicates if the field is the Shape field.
 

Method Detail

getDisplayName

String getDisplayName()
                      throws IOException,
                             AutomationException
Name for the reference data field to display in the user interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The label
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInternalName

String getInternalName()
                       throws IOException,
                              AutomationException
Internal name for the reference data field.

Description

The InternalName property returns the internal name for the ReferenceDataField used by the locator.

Remarks

The following is a listing of the internal names of the ReferenceDataFields used by the locators provided with ArcGIS 8:

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isObjectID

boolean isObjectID()
                   throws IOException,
                          AutomationException
Indicates if the field is the ObjectID field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The bShape
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShape

boolean isShape()
                throws IOException,
                       AutomationException
Indicates if the field is the Shape field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The bShape
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException
Name of the field in the reference data table.

Remarks

The Name property returns the actual name of the Field in the reference data source.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isRequired

boolean isRequired()
                   throws IOException,
                          AutomationException
Indicates whether the field is a required by the locator.

Remarks

If the Required property is False, then the reference data source does not need to contain this Field.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The bRequired
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.