com.esri.arcgis.schematic
Interface INgRecordset

All Superinterfaces:

Serializable

All Known Implementing Classes:

INgRecordsetProxy, NgADORecordset, NgDAORecordset

public interface INgRecordset
extends Serializable

Provides access to members that control the recordset.

Product Availability

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

See Also:

INgRecordsetDesign

Method Summary

void	close() Closes the recordset.
void	findRecord(String identifier) Points to the 'identifier' record in the recordset.
INgDataSource	getDataSource() Datasource related to the recordset.
String	getIdentifier() List of the field values that defines the object identifier.
INgParameters	getParameters() List of the parameters names specified for the recordset.
Object	getValue(String fieldName) Value of the field named 'FieldName' in the recordset.
boolean	isBOF() Indicates if the current record is positioned before the first record in the recordset.
boolean	isEOF() Indicates if the current record is positioned after the first record in the recordset.
void	moveFirst() Points to the first record in the recordset.
void	moveNext() Moves to the next record in the recordset.
void	open() Opens the recordset.
void	refresh() Refreshes the recordset; that is, reexecute the query.
void	setIdentifierFieldNames(INgNames names) List of the field names used to build the object identifier.
void	setParameterValues(INgValues values) List of the parameters values for the recordset.
void	update() Updates the recordset.

Method Detail

getDataSource

INgDataSource getDataSource()
                            throws IOException,
                                   AutomationException

Datasource related to the recordset.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.INgDataSource

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValue

Object getValue(String fieldName)
                throws IOException,
                       AutomationException

Value of the field named 'FieldName' in the recordset.

Product Availability

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

Parameters:

fieldName - The fieldName (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIdentifier

String getIdentifier()
                     throws IOException,
                            AutomationException

List of the field values that defines the object identifier.

Product Availability

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParameters

INgParameters getParameters()
                            throws IOException,
                                   AutomationException

List of the parameters names specified for the recordset.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.INgParameters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

void open()
          throws IOException,
                 AutomationException

Opens the recordset.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#close()

close

void close()
           throws IOException,
                  AutomationException

Closes the recordset.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#open()

refresh

void refresh()
             throws IOException,
                    AutomationException

Refreshes the recordset; that is, reexecute the query.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#update()

update

void update()
            throws IOException,
                   AutomationException

Updates the recordset. Uses to update a field value contained in the recordset.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#refresh()

setParameterValues

void setParameterValues(INgValues values)
                        throws IOException,
                               AutomationException

List of the parameters values for the recordset.

Product Availability

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

Parameters:

values - A reference to a com.esri.arcgis.schematic.INgValues (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIdentifierFieldNames

void setIdentifierFieldNames(INgNames names)
                             throws IOException,
                                    AutomationException

List of the field names used to build the object identifier.

Product Availability

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

Parameters:

names - A reference to a com.esri.arcgis.schematic.INgNames (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

moveFirst

void moveFirst()
               throws IOException,
                      AutomationException

Points to the first record in the recordset.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#isBOF(), com.esri.arcgis.schematic.INgRecordSet#moveNext(), com.esri.arcgis.schematic.INgRecordSet#isEOF(), com.esri.arcgis.schematic.INgRecordSet#findRecord(String)

moveNext

void moveNext()
              throws IOException,
                     AutomationException

Moves to the next record in the recordset.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#isBOF(), com.esri.arcgis.schematic.INgRecordSet#moveFirst(), com.esri.arcgis.schematic.INgRecordSet#isEOF(), com.esri.arcgis.schematic.INgRecordSet#findRecord(String)

findRecord

void findRecord(String identifier)
                throws IOException,
                       AutomationException

Points to the 'identifier' record in the recordset.

Product Availability

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

Parameters:

identifier - The identifier (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#isBOF(), com.esri.arcgis.schematic.INgRecordSet#moveFirst(), com.esri.arcgis.schematic.INgRecordSet#moveNext(), com.esri.arcgis.schematic.INgRecordSet#isEOF()

isBOF

boolean isBOF()
              throws IOException,
                     AutomationException

Indicates if the current record is positioned before the first record in the recordset.

Product Availability

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

Returns:

The bof

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#moveFirst(), com.esri.arcgis.schematic.INgRecordSet#moveNext(), com.esri.arcgis.schematic.INgRecordSet#isEOF()

isEOF

boolean isEOF()
              throws IOException,
                     AutomationException

Indicates if the current record is positioned after the first record in the recordset.

Product Availability

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

Returns:

The eof

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

com.esri.arcgis.schematic.INgRecordSet#isBOF(), com.esri.arcgis.schematic.INgRecordSet#moveFirst(), com.esri.arcgis.schematic.INgRecordSet#moveNext()