com.esri.arcgis.geoprocessing
Interface IGpEnumObject

All Superinterfaces:
Serializable
All Known Implementing Classes:
IGpEnumObjectProxy

public interface IGpEnumObject
extends Serializable

Provides access to the properties and methods of a Geoprocessing object enumerator object.

Product Availability

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

Supported Platforms

Windows


Method Summary
 void deleteRow(Object row)
          Inserts the row associated with the given cursor row.
 void insertRow(Object row)
          Inserts the row associated with the given cursor row.
 Object newRow()
          Creates and returns a new cursor row object.
 Object next()
          Returns the next object in the enumeration sequence.
 void reset()
          Resets the enumeration so the next returned string is the first.
 void setCursor(ICursor cursor, int cursorCookie, IFields fields, IGPFieldInfo fieldInfo, IRowBuffer pRowBuffer, IPropertySet pRowSet, boolean update, int updateType, int type, ISpatialReference pSpRef, boolean hasM, boolean hasZ, double defaultZ)
          Initializes the enumeration of rows based upon the given cursor.
 void setFields(IFields fields, String wildCard, String fieldType)
          Sets the fields to be used when creating cursors.
 void setIndexes(IIndexes indexes, String wildCard)
          Sets the indexes to be used when creating cursors.
 void updateRow(Object row)
          Updates the row associated with the given cursor row.
 

Method Detail

reset

void reset()
           throws IOException,
                  AutomationException
Resets the enumeration so the next returned string is the first.

Product Availability

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

Supported Platforms

Windows

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

next

Object next()
            throws IOException,
                   AutomationException
Returns the next object in the enumeration sequence.

Product Availability

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

Supported Platforms

Windows

Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

newRow

Object newRow()
              throws IOException,
                     AutomationException
Creates and returns a new cursor row object.

Product Availability

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

Supported Platforms

Windows

Returns:
A reference to another Automation Object (IDispatch)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFields

void setFields(IFields fields,
               String wildCard,
               String fieldType)
               throws IOException,
                      AutomationException
Sets the fields to be used when creating cursors.

Product Availability

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

Supported Platforms

Windows

Parameters:
fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)
wildCard - The wildCard (in)
fieldType - The fieldType (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIndexes

void setIndexes(IIndexes indexes,
                String wildCard)
                throws IOException,
                       AutomationException
Sets the indexes to be used when creating cursors.

Product Availability

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

Supported Platforms

Windows

Parameters:
indexes - A reference to a com.esri.arcgis.geodatabase.IIndexes (in)
wildCard - The wildCard (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCursor

void setCursor(ICursor cursor,
               int cursorCookie,
               IFields fields,
               IGPFieldInfo fieldInfo,
               IRowBuffer pRowBuffer,
               IPropertySet pRowSet,
               boolean update,
               int updateType,
               int type,
               ISpatialReference pSpRef,
               boolean hasM,
               boolean hasZ,
               double defaultZ)
               throws IOException,
                      AutomationException
Initializes the enumeration of rows based upon the given cursor.

Product Availability

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

Supported Platforms

Windows

Parameters:
cursor - A reference to a com.esri.arcgis.geodatabase.ICursor (in)
cursorCookie - The cursorCookie (in)
fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)
fieldInfo - A reference to a com.esri.arcgis.geoprocessing.IGPFieldInfo (in)
pRowBuffer - A reference to a com.esri.arcgis.geodatabase.IRowBuffer (in)
pRowSet - A reference to a com.esri.arcgis.system.IPropertySet (in)
update - The update (in)
updateType - The updateType (in)
type - A com.esri.arcgis.geometry.esriGeometryType constant (in)
pSpRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
hasM - The hasM (in)
hasZ - The hasZ (in)
defaultZ - The defaultZ (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateRow

void updateRow(Object row)
               throws IOException,
                      AutomationException
Updates the row associated with the given cursor row.

Product Availability

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

Supported Platforms

Windows

Parameters:
row - A reference to another Automation Object (IDispatch) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

insertRow

void insertRow(Object row)
               throws IOException,
                      AutomationException
Inserts the row associated with the given cursor row.

Product Availability

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

Supported Platforms

Windows

Parameters:
row - A reference to another Automation Object (IDispatch) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteRow

void deleteRow(Object row)
               throws IOException,
                      AutomationException
Inserts the row associated with the given cursor row.

Product Availability

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

Supported Platforms

Windows

Parameters:
row - A reference to another Automation Object (IDispatch) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.