com.esri.arcgis.geodatabase
Interface IRecordSetInit

All Superinterfaces:

Serializable

All Known Implementing Classes:

RecordSet

public interface IRecordSetInit
extends Serializable

Provides access to methods that allow construction of recordsets based on source row or feature collections.

Remarks

The IRecordsetInit interface is used to initialize the Recordset coclass. The coclass must be intialized before any of the other interfaces in the coclass can be used.

Product Availability

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

Method Summary

IRowBuffer	createRowBuffer() Creates a row buffer that can be used with an insert cursor.
void	createTable(IFields fields) Creates an empty table or feature class for a Recordset.
int	getMaxRecordCount() The maximum number of records for the recordset.
ICursor	insert() Returns a cursor that can be used to insert new rows.
void	setMaxRecordCount(int maxRecordCount) The maximum number of records for the recordset.
void	setSourceQueryDef(IQueryDef queryDef) Sets the source QueryDef for a Recordset.
void	setSourceTable(ITable table, IQueryFilter queryFilter) Sets the source table or feature class for a Recordset.

Method Detail

getMaxRecordCount

int getMaxRecordCount()
                      throws IOException,
                             AutomationException

The maximum number of records for the recordset.

Remarks

When using a recordset class, the MaxRecordCount property is used to return the maximum number of records for the recordset.

Product Availability

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

Returns:

The maxRecordCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRecordCount

void setMaxRecordCount(int maxRecordCount)
                       throws IOException,
                              AutomationException

The maximum number of records for the recordset.

Product Availability

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

Parameters:

maxRecordCount - The maxRecordCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceTable

void setSourceTable(ITable table,
                    IQueryFilter queryFilter)
                    throws IOException,
                           AutomationException

Sets the source table or feature class for a Recordset.

Remarks

When using a recordset class, the SetSourceTable property is used to set the source table or feature class for a Recordset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

table - A reference to a com.esri.arcgis.geodatabase.ITable (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceQueryDef

void setSourceQueryDef(IQueryDef queryDef)
                       throws IOException,
                              AutomationException

Sets the source QueryDef for a Recordset.

Remarks

When using a recordset class, the SetSourceQueryDef property is used to sets the source QueryDef for a Recordset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

queryDef - A reference to a com.esri.arcgis.geodatabase.IQueryDef (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createTable

void createTable(IFields fields)
                 throws IOException,
                        AutomationException

Creates an empty table or feature class for a Recordset.

Remarks

When using a recordset class, the CreateTable property is used to create an empty table or feature class for a RecordSet.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fields - A reference to a com.esri.arcgis.geodatabase.IFields (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createRowBuffer

IRowBuffer createRowBuffer()
                           throws IOException,
                                  AutomationException

Creates a row buffer that can be used with an insert cursor.

Remarks

When using a recordset class, the CreateRowBuffer property is used to create a row buffer that can be used with an insert cursor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.IRowBuffer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

ICursor insert()
               throws IOException,
                      AutomationException

Returns a cursor that can be used to insert new rows.

Remarks

When using a recordset class, the Insert property is used to return a cursor that can be used to insert new rows into a RecordSet.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geodatabase.ICursor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.