LibreOffice
LibreOffice 6.2 SDK API Reference
Included Services | Exported Interfaces | List of all members
ResultSet Service Referencepublished

extends the com::sun::star::sdbcx::ResultSet by a more sophisticated access to the result sets data. More...

import"ResultSet.idl";

Inheritance diagram for ResultSet:
ResultSet XColumnsSupplier ResultSet XCancellable XRowLocate XDeleteRows XInterface XInterface XInterface XInterface XRowUpdate XColumnLocate XRow XResultSetUpdate XResultSet XResultSetMetaDataSupplier XWarningsSupplier XPropertySet XCloseable XComponent RowSet DataForm

Included Services

service com::sun::star::sdbcx::ResultSet
 
- Included Services inherited from ResultSet
service com::sun::star::sdbc::ResultSet
 

Exported Interfaces

interface com::sun::star::sdbcx::XColumnsSupplier
 access to the description and data. More...
 
- Exported Interfaces inherited from ResultSet
interface com::sun::star::util::XCancellable
 could be used for canceling the execution of SQL statements if both the DBMS and the driver support aborting of navigation commands. More...
 
interface XRowLocate
 is the interface for navigating on the result set by unique bookmarks. More...
 
interface XDeleteRows
 is the interface for deleting more than one row, identified by its bookmark. More...
 
- Exported Interfaces inherited from ResultSet
interface com::sun::star::lang::XComponent
 optional for implementation; controls the releasing of resources and the notification of registered listeners. More...
 
interface XCloseable
 freeing all resources of a result set. More...
 
interface com::sun::star::beans::XPropertySet
 
interface XWarningsSupplier
 controls the chaining of warnings, which may occur on every call to the connected database. More...
 
interface XResultSetMetaDataSupplier
 provides the access to the result set description. More...
 
interface XResultSet
 is the interface for navigating on the rows on a result set. More...
 
interface XResultSetUpdate
 is the interface for updating row data to the database. More...
 
interface XRow
 is the interface for accessing the data of the current row. More...
 
interface XColumnLocate
 is used for locating a column by its name. More...
 
interface XRowUpdate
 is the interface for updating the data of the current row. More...
 

Additional Inherited Members

- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. 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...
 
- Public Member Functions inherited from XResultSetMetaDataSupplier
XResultSetMetaData getMetaData () raises (SQLException)
 retrieves the number, types, and properties of a ResultSet's columns. More...
 
- Public Member Functions inherited from XResultSet
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 XRow
boolean wasNull () raises (SQLException)
 reports whether the last column read had a value of SQL NULL. More...
 
string getString ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a string. More...
 
boolean getBoolean ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as boolean. More...
 
byte getByte ([in]long columnIndex) raises (SQLException)
 get the value of a column in the current row as a byte. More...
 
short getShort ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a short. More...
 
long getInt ([in]long columnIndex) raises (SQLException)
 get the value of a column in the current row as an integer. More...
 
hyper getLong ([in]long columnIndex) raises (SQLException)
 get the value of a column in the current row as a long. More...
 
float getFloat ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a float. More...
 
double getDouble ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a double. More...
 
sequence< byte > getBytes ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a byte array. More...
 
com::sun::star::util::Date getDate ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a date object. More...
 
com::sun::star::util::Time getTime ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a time object. More...
 
com::sun::star::util::DateTime getTimestamp ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a datetime object. More...
 
com::sun::star::io::XInputStream getBinaryStream ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a stream of uninterpreted bytes. More...
 
com::sun::star::io::XInputStream getCharacterStream ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a stream of uninterpreted bytes. More...
 
any getObject ([in]long columnIndex, [in]com::sun::star::container::XNameAccess typeMap) raises (SQLException)
 returns the value of a column in the current row as an object. More...
 
XRef getRef ([in]long columnIndex) raises (SQLException)
 gets a REF(&lt;structured-type&gt;) column value from the current row. More...
 
XBlob getBlob ([in]long columnIndex) raises (SQLException)
 gets a BLOB value in the current row. More...
 
XClob getClob ([in]long columnIndex) raises (SQLException)
 gets a CLOB value in the current row of this ResultSet object. More...
 
XArray getArray ([in]long columnIndex) raises (SQLException)
 gets a SQL ARRAY value from the current row of this ResultSet object. More...
 
- Public Member Functions inherited from XColumnLocate
long findColumn ([in]string columnName) raises (SQLException)
 maps the given ResultSet column name to its ResultSet column index. More...
 
- Public Member Functions inherited from XRowLocate
any getBookmark () raises (com::sun::star::sdbc::SQLException)
 returns the bookmark of the current row of a result set. More...
 
boolean moveToBookmark ([in]any bookmark) raises (com::sun::star::sdbc::SQLException)
 moves the cursor to the row identified by an valid bookmark. More...
 
boolean moveRelativeToBookmark ([in]any bookmark, [in]long rows) raises (com::sun::star::sdbc::SQLException)
 moves the cursor a relative number of rows, either positive or negative starting at a given bookmark position. More...
 
long compareBookmarks ([in]any first, [in]any second) raises (com::sun::star::sdbc::SQLException)
 compares two bookmarks and returns an indication of their relative values. More...
 
boolean hasOrderedBookmarks () raises (com::sun::star::sdbc::SQLException)
 determines whether the bookmarks of a result set are ordered or not. More...
 
long hashBookmark ([in]any bookmark) raises (com::sun::star::sdbc::SQLException)
 returns the hash value for a specified bookmark. More...
 
- Public Member Functions inherited from XColumnsSupplier
com::sun::star::container::XNameAccess getColumns ()
 returns the container of columns. More...
 
- Public Attributes inherited from ResultSet
boolean IsBookmarkable
 returns if the result set supports bookmark navigation. More...
 
boolean CanUpdateInsertedRows
 returns whether the result set supports updating of newly inserted rows. More...
 
- Public Attributes inherited from ResultSet
string CursorName
 defines the SQL cursor name that will be used by subsequent Statement execute methods. More...
 
long ResultSetConcurrency
 retrieves the result set concurrency. More...
 
long ResultSetType
 determines the result set type. More...
 
long FetchDirection
 retrieves the direction for fetching rows from database tables that is the default for result sets generated from this com::sun::star::sdbcx::Statement object. More...
 
long FetchSize
 retrieves the number of result set rows that is the default fetch size for result sets generated from this com::sun::star::sdbcx::Statement object. More...
 
- Protected Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. More...
 
- Protected 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...
 
- Protected Member Functions inherited from XCloseable
void close () raises (SQLException)
 releases all resources connected to an object. More...
 
- Protected Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Protected Member Functions inherited from XWarningsSupplier
any getWarnings () raises (SQLException)
 returns the first warning reported by calls on an object that supports the usage of warnings. More...
 
void clearWarnings () raises (SQLException)
 clears all warnings reported for the object implementing the interface. More...
 
- Protected Member Functions inherited from XResultSetMetaDataSupplier
XResultSetMetaData getMetaData () raises (SQLException)
 retrieves the number, types, and properties of a ResultSet's columns. More...
 
- Protected Member Functions inherited from XResultSet
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...
 
- Protected Member Functions inherited from XResultSetUpdate
void insertRow () raises (SQLException)
 inserts the contents of the insert row into the result set and the database. More...
 
void updateRow () raises (SQLException)
 updates the underlying database with the new contents of the current row. More...
 
void deleteRow () raises (SQLException)
 deletes the current row from the result set and the underlying database. More...
 
void cancelRowUpdates () raises (SQLException)
 cancels the updates made to a row. More...
 
void moveToInsertRow () raises (SQLException)
 moves the cursor to the insert row. More...
 
void moveToCurrentRow () raises (SQLException)
 moves the cursor to the remembered cursor position, usually the current row. More...
 
- Protected Member Functions inherited from XRow
boolean wasNull () raises (SQLException)
 reports whether the last column read had a value of SQL NULL. More...
 
string getString ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a string. More...
 
boolean getBoolean ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as boolean. More...
 
byte getByte ([in]long columnIndex) raises (SQLException)
 get the value of a column in the current row as a byte. More...
 
short getShort ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a short. More...
 
long getInt ([in]long columnIndex) raises (SQLException)
 get the value of a column in the current row as an integer. More...
 
hyper getLong ([in]long columnIndex) raises (SQLException)
 get the value of a column in the current row as a long. More...
 
float getFloat ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a float. More...
 
double getDouble ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a double. More...
 
sequence< byte > getBytes ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a byte array. More...
 
com::sun::star::util::Date getDate ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a date object. More...
 
com::sun::star::util::Time getTime ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a time object. More...
 
com::sun::star::util::DateTime getTimestamp ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a datetime object. More...
 
com::sun::star::io::XInputStream getBinaryStream ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a stream of uninterpreted bytes. More...
 
com::sun::star::io::XInputStream getCharacterStream ([in]long columnIndex) raises (SQLException)
 gets the value of a column in the current row as a stream of uninterpreted bytes. More...
 
any getObject ([in]long columnIndex, [in]com::sun::star::container::XNameAccess typeMap) raises (SQLException)
 returns the value of a column in the current row as an object. More...
 
XRef getRef ([in]long columnIndex) raises (SQLException)
 gets a REF(&lt;structured-type&gt;) column value from the current row. More...
 
XBlob getBlob ([in]long columnIndex) raises (SQLException)
 gets a BLOB value in the current row. More...
 
XClob getClob ([in]long columnIndex) raises (SQLException)
 gets a CLOB value in the current row of this ResultSet object. More...
 
XArray getArray ([in]long columnIndex) raises (SQLException)
 gets a SQL ARRAY value from the current row of this ResultSet object. More...
 
- Protected Member Functions inherited from XColumnLocate
long findColumn ([in]string columnName) raises (SQLException)
 maps the given ResultSet column name to its ResultSet column index. More...
 
- Protected Member Functions inherited from XRowUpdate
void updateNull ([in]long columnIndex) raises (SQLException)
 gives a nullable column a null value. More...
 
void updateBoolean ([in]long columnIndex, [in]boolean x) raises (SQLException)
 updates a column with a boolean value. More...
 
void updateByte ([in]long columnIndex, [in]byte x) raises (SQLException)
 updates a column with a byte value. More...
 
void updateShort ([in]long columnIndex, [in]short x) raises (SQLException)
 updates a column with a short value. More...
 
void updateInt ([in]long columnIndex, [in]long x) raises (SQLException)
 updates a column with an long value. More...
 
void updateLong ([in]long columnIndex, [in]hyper x) raises (SQLException)
 updates a column with a hyper value. More...
 
void updateFloat ([in]long columnIndex, [in]float x) raises (SQLException)
 updates a column with a float value. More...
 
void updateDouble ([in]long columnIndex, [in]double x) raises (SQLException)
 updates a column with a double value. More...
 
void updateString ([in]long columnIndex, [in]string x) raises (SQLException)
 updates a column with a string value. More...
 
void updateBytes ([in]long columnIndex, [in]sequence< byte > x) raises (SQLException)
 updates a column with a byte array value. More...
 
void updateDate ([in]long columnIndex, [in]com::sun::star::util::Date x) raises (SQLException)
 updates a column with a date value. More...
 
void updateTime ([in]long columnIndex, [in]com::sun::star::util::Time x) raises (SQLException)
 updates a column with a time value. More...
 
void updateTimestamp ([in]long columnIndex, [in]com::sun::star::util::DateTime x) raises (SQLException)
 updates a column with a timestamp value. More...
 
void updateBinaryStream ([in]long columnIndex, [in]com::sun::star::io::XInputStream x, [in]long length) raises (SQLException)
 updates a column with a stream value. More...
 
void updateCharacterStream ([in]long columnIndex, [in]com::sun::star::io::XInputStream x, [in]long length) raises (SQLException)
 updates a column with a stream value. More...
 
void updateObject ([in]long columnIndex, [in]any x) raises (SQLException)
 updates a column with an object value. More...
 
void updateNumericObject ([in]long columnIndex, [in]any x, [in]long scale) raises (SQLException)
 updates a column with an object value. More...
 
- Protected Member Functions inherited from XCancellable
void cancel ()
 cancels the current job of the object. More...
 
- Protected Member Functions inherited from XRowLocate
any getBookmark () raises (com::sun::star::sdbc::SQLException)
 returns the bookmark of the current row of a result set. More...
 
boolean moveToBookmark ([in]any bookmark) raises (com::sun::star::sdbc::SQLException)
 moves the cursor to the row identified by an valid bookmark. More...
 
boolean moveRelativeToBookmark ([in]any bookmark, [in]long rows) raises (com::sun::star::sdbc::SQLException)
 moves the cursor a relative number of rows, either positive or negative starting at a given bookmark position. More...
 
long compareBookmarks ([in]any first, [in]any second) raises (com::sun::star::sdbc::SQLException)
 compares two bookmarks and returns an indication of their relative values. More...
 
boolean hasOrderedBookmarks () raises (com::sun::star::sdbc::SQLException)
 determines whether the bookmarks of a result set are ordered or not. More...
 
long hashBookmark ([in]any bookmark) raises (com::sun::star::sdbc::SQLException)
 returns the hash value for a specified bookmark. More...
 
- Protected Member Functions inherited from XDeleteRows
sequence< long > deleteRows ([in]sequence< any > rows) raises (com::sun::star::sdbc::SQLException)
 deletes one or more rows identified by their bookmarks. More...
 

Detailed Description

extends the com::sun::star::sdbcx::ResultSet by a more sophisticated access to the result sets data.

Developers Guide
Database - Result Sets
Database - Clones of the RowSet Service

Exported Interfaces

Exported Interfaces

access to the description and data.


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