ResultSet Class Reference

FOR INTERNAL USE - do not invoke directly. More...

Inheritance diagram for ResultSet:

Collaboration diagram for ResultSet:

Public Member Functions
_.Library.RawString	Get (_.Library.RawString colname)
	Returns the value of the column with the name colname in the current row of the result set. More...
_.Library.List	GetBuffer (_.Library.Boolean moreBuffers)
	Returns the current row buffer to the caller. More...
_.XDBC.Gateway.ResultSetMetaData	GetMetaData ()
	Return the result set metadata as a SQL.StatementMetadata instance.
_.Library.ObjectHandle	GetObject (_.Library.Integer columnIndex)
	Gets the value of the designated column in the current row of this ResultSet object as ObjectHandle.
_.Library.List	GetRow ()
	Advance to the next row in the result referenced by <property>ProcCursor</property>. More...
_.Library.Integer	GetRows (_.Library.Integer rowCount)
	Advance the next <parameter>rowCount</parameter> rows in the result referenced by <property>ProcCursor</property>. More...
_.Library.Boolean	Next ()
	Advance to the next row in the result referenced by <property>ProcCursor</property>. More...
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Private Member Functions
_.Library.RegisteredObject	ConstructClone (_.Library.Boolean deep, _.Library.String cloned, _.Library.String location)
	FOR INTERNAL USE - do not invoke directly.
_.Library.Status	NormalizeObject ()
	Normalizes all of an object's property values by invoking the data type Normalize methods. More...
_.Library.Status	Print (_.Library.String pDelimiter)
	Print() - This is an abstract method. More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

FOR INTERNAL USE - do not invoke directly.

Member Function Documentation

NormalizeObject()

_.Library.Status NormalizeObject ( )

private

Normalizes all of an object's property values by invoking the data type Normalize methods.

Many data types may allow many different representations of the same value. 
Normalization converts a value to its cannonical, or <em>normalized</em>, form.

Reimplemented from RegisteredObject.

Print()

_.Library.Status Print ( _.Library.String  pDelimiter )

private

Print() - This is an abstract method.

Refer to <class>SQL.IResultSet</class> for the

concrete method implemented for result set results.

Get()

_.Library.RawString Get

(

_.Library.RawString

colname

)

Returns the value of the column with the name colname in the current row of the result set.

If colname is not a valid column name, this method throws a <PROPERTY DOES NOT EXIST> error.

Reimplemented in ResultSet, and ResultSet.

GetBuffer()

_.Library.List GetBuffer

(

_.Library.Boolean

moreBuffers

)

Returns the current row buffer to the caller.

This method will refuse to return the buffer if there result set is already being iterated over by cursor (if the cursor is not before the start of the result set)

Reimplemented in ResultSet.

GetRow()

_.Library.List GetRow

(

)

Advance to the next row in the result referenced by <property>ProcCursor</property>.

Returns 0 if the cursor is at the end of the

result set. An optional argument contains a <class>Library.Status</class> value on return. This Status value indicates success or failure of the <method>GetRow</method> call. <property>SQLCODE</property> is also set by <method>GetRow</method>. The row is returned in $List format by reference in the <parameter>Row</parameter> argument. If SQLCODE'=0, Row will be null (""). This implementation is overridden by classes that implement the result set interface.

Reimplemented in ResultSet, and ResultSet.

GetRows()

_.Library.Integer GetRows

(

_.Library.Integer

rowCount

)

Advance the next <parameter>rowCount</parameter> rows in the result referenced by <property>ProcCursor</property>.

Returns 0 if the cursor is at the end of the

result set. Note, when 0 is returned, it is likely there are rows returned in the <parameter>Rows</parameter> array. An optional argument contains a <class>Library.Status</class> value on return. This Status value indicates success or failure of the <method>GetRows</method> call. <property>SQLCODE</property> is also set by GetRows. The rows are returned in an array of $List values in the <parameter>Row</parameter> array argument. If SQLCODE'=0 for a row, that will be the end of the results.

For example, suppose rset.GetRows(10,.tenrows,.sc) is called:
- If there are more then 10 rows remaining to be fetched from the result set, tenrows=10, tenrows(1)=$lb(first row's contents), ..., tenrows(10)=$lb(tenth row's contents), and <method>GetRows</method> will return 1.
- If there are 5 rows remaining to be fetched from the result set, tenrows=5, tenrows(1)=$lb(first row's contents), ..., tenrows(5)=$lb(fifth row's contents), and <method>GetRows</method> will return 0.
- If there are 0 rows remaining to be fetched from the result set, tenrows=0 and <method>GetRows</method> will return 0.

This implementation is overridden by classes that implement the result set interface.

Reimplemented in ResultSet.

Next()

_.Library.Boolean Next

(

)

Advance to the next row in the result referenced by <property>ProcCursor</property>.

Returns 0 if the cursor is at the end of the

result set. An optional argument contains a <class>Library.Status</class> value on return. This Status value indicates success or failure of the Next call. <property>SQLCODE</property> is also set by Next. This implementation is overridden by classes that implement the result set interface.

Reimplemented in ResultSet, ResultSet, ResultSet, and ResultSet.