com.esri.arcgis.geoprocessing
Interface IGpDescribeIndex

All Superinterfaces:
Serializable
All Known Implementing Classes:
IGpDescribeIndexProxy

public interface IGpDescribeIndex
extends Serializable

Provides access to the properties of a Geoprocessing Index Description object.

Product Availability

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

Supported Platforms

Windows


Method Summary
 IGpEnumObject getFields()
          Enumeration of fields in the index description.
 String getIsAscending()
          Indicates whether the index description is sorted in ascending order.
 String getIsUnique()
          Indicates whether the index description is unique.
 String getName()
          Name of the index description.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
Name of the index description.

Product Availability

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

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

getIsAscending

String getIsAscending()
                      throws IOException,
                             AutomationException
Indicates whether the index description is sorted in ascending order.

Product Availability

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

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

getIsUnique

String getIsUnique()
                   throws IOException,
                          AutomationException
Indicates whether the index description is unique.

Product Availability

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

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

getFields

IGpEnumObject getFields()
                        throws IOException,
                               AutomationException
Enumeration of fields in the index description.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geoprocessing.IGpEnumObject
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.