LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XResultSet Interface Referencepublished

provides the navigation on a table of data. More...

import"XResultSet.idl";

Inheritance diagram for XResultSet:
XInterface ResultSet XRowSet ContentResultSet RowSet ResultSet ContentResultSet XDatabaseDataProvider RowSet CachedContentResultSet CachedContentResultSetStub RowSet ResultSet CachedContentResultSet CachedContentResultSetStub DatabaseDataProvider RowSet DataForm RowSet DataForm DataForm

Public Member Functions

boolean next () raises (SQLException)
 moves the cursor down one row from its current position. More...
 
boolean isBeforeFirst () raises (SQLException)
 indicates whether the cursor is before the first row in the result set. More...
 
boolean isAfterLast () raises (SQLException)
 indicates whether the cursor is after the last row in the result set. More...
 
boolean isFirst () raises (SQLException)
 indicates whether the cursor is on the first row of the result set. More...
 
boolean isLast () raises (SQLException)
 indicates whether the cursor is on the last row of the result set. More...
 
void beforeFirst () raises (SQLException)
 moves the cursor to the front of the result set, just before the first row. More...
 
void afterLast () raises (SQLException)
 moves the cursor to the end of the result set, just after the last row. More...
 
boolean first () raises (SQLException)
 moves the cursor to the first row in the result set. More...
 
boolean last () raises (SQLException)
 moves the cursor to the last row in the result set. More...
 
long getRow () raises (SQLException)
 retrieves the current row number. More...
 
boolean absolute ([in] long row) raises (SQLException)
 moves the cursor to the given row number in the result set. More...
 
boolean relative ([in]long rows) raises (SQLException)
 moves the cursor a relative number of rows, either positive or negative. More...
 
boolean previous () raises (SQLException)
 moves the cursor to the previous row in the result set. More...
 
void refreshRow () raises (SQLException)
 refreshes the current row with its most recent value in the database. More...
 
boolean rowUpdated () raises (SQLException)
 indicates whether the current row has been updated. More...
 
boolean rowInserted () raises (SQLException)
 indicates whether the current row has had an insertion. More...
 
boolean rowDeleted () raises (SQLException)
 indicates whether a row has been deleted. More...
 
com::sun::star::uno::XInterface getStatement () raises (SQLException)
 returns the Statement that produced this com::sun::star::sdbc::ResultSet object. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

provides the navigation on a table of data.

A com::sun::star::sdbc::ResultSet object is usually generated by executing a com::sun::star::sdbc::Statement.

A ResultSet maintains a cursor pointing to its current row of data. Initially the cursor is positioned before the first row. The "next" method moves the cursor to the next row.

Developers Guide
Database - Scrollable Result Sets

Member Function Documentation

boolean absolute ( [in] long  row)
raises (SQLException
)

moves the cursor to the given row number in the result set.

If the row number is positive, the cursor moves to the given row number with respect to the beginning of the result set. The first row is row 1, the second is row 2, and so on.

If the given row number is negative, the cursor moves to an absolute row position with respect to the end of the result set. For example, calling absolute(-1) positions the cursor on the last row, absolute(-2) indicates the next-to-last row, and so on.

An attempt to position the cursor beyond the first/last row in the result set leaves the cursor before/after the first/last row, respectively.

Note: Calling absolute(1) is the same as calling com::sun::star::sdbc::XResultSet::first(). Calling moveToPosition(-1) is the same as calling moveToLast().

void afterLast ( )
raises (SQLException
)

moves the cursor to the end of the result set, just after the last row.

Has no effect if the result set contains no rows.

Exceptions
SQLExceptionif a database access error occurs.
void beforeFirst ( )
raises (SQLException
)

moves the cursor to the front of the result set, just before the first row.

Has no effect if the result set contains no rows.

Exceptions
SQLExceptionif a database access error occurs.
boolean first ( )
raises (SQLException
)

moves the cursor to the first row in the result set.

Returns
TRUE if successful
Exceptions
SQLExceptionif a database access error occurs.
long getRow ( )
raises (SQLException
)

retrieves the current row number.

The first row is number 1, the second number 2, and so on.

Returns
the current position
Exceptions
SQLExceptionif a database access error occurs.
com::sun::star::uno::XInterface getStatement ( )
raises (SQLException
)

returns the Statement that produced this com::sun::star::sdbc::ResultSet object.

If the result set was generated some other way, such as by an com::sun::star::sdbc::XDatabaseMetaData method, this method returns NULL.

Returns
the statement object
Exceptions
SQLExceptionif a database access error occurs.
boolean isAfterLast ( )
raises (SQLException
)

indicates whether the cursor is after the last row in the result set.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean isBeforeFirst ( )
raises (SQLException
)

indicates whether the cursor is before the first row in the result set.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean isFirst ( )
raises (SQLException
)

indicates whether the cursor is on the first row of the result set.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean isLast ( )
raises (SQLException
)

indicates whether the cursor is on the last row of the result set.

Note: Calling the method isAtLast may be expensive because the SDBC driver might need to fetch ahead one row in order to determine whether the current row is the last row in the result set.

Returns
TRUE if so
Exceptions
SQLExceptionif a database access error occurs.
boolean last ( )
raises (SQLException
)

moves the cursor to the last row in the result set.

Returns
TRUE if successful
Exceptions
SQLExceptionif a database access error occurs.
boolean next ( )
raises (SQLException
)

moves the cursor down one row from its current position.

A ResultSet cursor is initially positioned before the first row; the first call to next makes the first row the current row; the second call makes the second row the current row, and so on.

If an input stream is open for the current row, a call to the method next will implicitly close it. The ResultSet's warning chain is cleared when a new row is read.

Returns
TRUE if successful
Exceptions
SQLExceptionif a database access error occurs.
boolean previous ( )
raises (SQLException
)

moves the cursor to the previous row in the result set.

Note: previous() is not the same as relative(-1) because it makes sense to call previous() when there is no current row.

Returns
TRUE if successful
Exceptions
SQLExceptionif a database access error occurs.
void refreshRow ( )
raises (SQLException
)

refreshes the current row with its most recent value in the database.

Cannot be called when on the insert row. The refreshRow method provides a way for an application to explicitly tell the SDBC driver to refetch a row(s) from the database. An application may want to call refreshRow when caching or prefetching is being done by the SDBC driver to fetch the latest value of a row from the database. The SDBC driver may actually refresh multiple rows at once if the fetch size is greater than one. All values are refetched subject to the transaction isolation level and cursor sensitivity. If refreshRow is called after calling updateXXX , but before calling com::sun::star::sdbc::XResultSet::updateRow() , then the updates made to the row are lost. Calling the method refreshRow frequently will likely slow performance.

Exceptions
SQLExceptionif a database access error occurs.
boolean relative ( [in] long  rows)
raises (SQLException
)

moves the cursor a relative number of rows, either positive or negative.

Attempting to move beyond the first/last row in the result set positions the cursor before/after the first/last row. Calling relative(0) is valid, but does not change the cursor position.

Note: Calling relative(1) is different from calling com::sun::star::sdbc::XResultSet::next() because is makes sense to call next() when there is no current row, for example, when the cursor is positioned before the first row or after the last row of the result set.

Parameters
rowshow many rows should be moved relative to the current row
Returns
TRUE if successful
Exceptions
SQLExceptionif a database access error occurs.
boolean rowDeleted ( )
raises (SQLException
)

indicates whether a row has been deleted.

A deleted row may leave a visible "hole" in a result set. This method can be used to detect holes in a result set. The value returned depends on whether or not the result set can detect deletions.

Returns
TRUE if successful
Exceptions
SQLExceptionif a database access error occurs.
boolean rowInserted ( )
raises (SQLException
)

indicates whether the current row has had an insertion.

The value returned depends on whether or not the result set can detect visible inserts.

Returns
TRUE if successful
Exceptions
SQLExceptionif a database access error occurs.
boolean rowUpdated ( )
raises (SQLException
)

indicates whether the current row has been updated.

The value returned depends on whether or not the result set can detect updates.

Returns
TRUE if successful
Exceptions
SQLExceptionif a database access error occurs.

The documentation for this interface was generated from the following file: