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

is a client side RowSet, which use retrieves is data based on a database table, a query or a SQL command or by a row set reader, who mustn't support SQL. More...

import"RowSet.idl";

Inheritance diagram for RowSet:
XParametersSupplier XResultSetAccess XDeleteRows XResultSetUpdate XRowSetApproveBroadcaster XCompletedExecution ResultSet RowSet DataForm

Included Services

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

Exported Interfaces

interface com::sun::star::sdb::XCompletedExecution
 can be used to allow an interaction handler to supply missing data during a execute process. More...
 
interface XRowSetApproveBroadcaster
 approving of actions performed on the row set. More...
 
interface com::sun::star::sdbc::XResultSetUpdate
 is the interface for updating row data to the database. More...
 
interface com::sun::star::sdbcx::XDeleteRows
 is the interface for deleting more than one row, identified by its bookmark. More...
 
interface XResultSetAccess
 creates a second result set which is based on the same data. More...
 
interface XParametersSupplier
 gives access to the parameters contained in the SQL statement represented by the component. More...
 
- Exported Interfaces inherited from RowSet
interface XRowSet
 used to execute and to add/remove listeners. More...
 
interface XParameters
 
interface XColumnLocate
 allows locating columns whose name is known only. 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...
 
- Exported Interfaces inherited from ResultSet
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...
 

Public Attributes

com::sun::star::sdbc::XConnection ActiveConnection
 is the connection generated by a DataSource or by a URL. More...
 
string DataSourceName
 is the name of the datasource to use, this could be a named datasource or the URL of a data access component. More...
 
string Command
 is the command which should be executed, the type of command depends on the CommandType. More...
 
long CommandType
 is the type of the command. More...
 
string ActiveCommand
 is the command which is currently used. More...
 
boolean IgnoreResult
 indicates whether all results should be discarded or not. More...
 
string Filter
 additional filter for a row set. More...
 
boolean ApplyFilter
 indicates whether the filter should be applied or not, default is FALSE. More...
 
string HavingClause
 additional having clause for the row set More...
 
string GroupBy
 additional group by for the row set More...
 
string Order
 is a additional sort order definition for a row set. More...
 
long Privileges
 indicates the privileges for insert, update, and delete. More...
 
boolean IsModified
 indicates that the current row is modified. More...
 
boolean IsNew
 indicates that the current row is going to be inserted to the database. More...
 
long RowCount
 contains the number of rows accessed in a the data source. More...
 
boolean IsRowCountFinal
 indicates that all rows of the row set have been counted. More...
 
string UpdateTableName
 is the name of the table which should be updated, this is usually used for queries which relate to more than one table. More...
 
string UpdateCatalogName
 is the name of the table catalog More...
 
string UpdateSchemaName
 is the name of the table schema. More...
 
- Public Attributes inherited from RowSet
string DataSourceName
 is the name of a named datasource to use. More...
 
string URL
 is the connection URL. More...
 
string Command
 is the command which should be executed. More...
 
long TransactionIsolation
 indicates the transaction isolation level, which should be used for the connection. More...
 
com::sun::star::container::XNameAccess TypeMap
 is the type map that will be used for the custom mapping of SQL structured types and distinct types. More...
 
boolean EscapeProcessing
 returns if escape processing is on or off. More...
 
long QueryTimeOut
 retrieves the number of seconds the driver will wait for a Statement to execute. More...
 
long MaxFieldSize
 returns the maximum number of bytes allowed for any column value. More...
 
long MaxRows
 retrieves the maximum number of rows that a ResultSet can contain. More...
 
string User
 determines the user for whom to open the connection. More...
 
string Password
 determines the user for whom to open the connection. More...
 
long ResultSetType
 determine the result set type. 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...
 
- 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...
 

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 XRowSet
void execute () raises (SQLException)
 populates a row set with data. More...
 
void addRowSetListener ([in]XRowSetListener listener)
 adds the specified listener to receive the events "cursorMoved", "rowChanged", and "rowSetChanged". More...
 
void removeRowSetListener ([in]XRowSetListener listener)
 removes the specified listener. More...
 
- Public Member Functions inherited from XParameters
void setNull ([in]long parameterIndex, [in]long sqlType) raises (SQLException)
 sets the designated parameter to SQL NULL. More...
 
void setObjectNull ([in]long parameterIndex, [in]long sqlType, [in]string typeName) raises (SQLException)
 sets the designated parameter to SQL NULL. More...
 
void setBoolean ([in]long parameterIndex, [in]boolean x) raises (SQLException)
 sets the designated parameter to a boolean value. More...
 
void setByte ([in]long parameterIndex, [in]byte x) raises (SQLException)
 sets the designated parameter to a byte value. More...
 
void setShort ([in]long parameterIndex, [in]short x) raises (SQLException)
 sets the designated parameter to a short value. More...
 
void setInt ([in]long parameterIndex, [in]long x) raises (SQLException)
 sets the designated parameter to a long value. More...
 
void setLong ([in]long parameterIndex, [in]hyper x) raises (SQLException)
 sets the designated parameter to a hyper value. More...
 
void setFloat ([in]long parameterIndex, [in]float x) raises (SQLException)
 sets the designated parameter to a float value. More...
 
void setDouble ([in]long parameterIndex, [in]double x) raises (SQLException)
 sets the designated parameter to a double value. More...
 
void setString ([in]long parameterIndex, [in]string x) raises (SQLException)
 sets the designated parameter to a string value. More...
 
void setBytes ([in]long parameterIndex, [in]sequence< byte > x) raises (SQLException)
 sets the designated parameter to a sequence of bytes. More...
 
void setDate ([in]long parameterIndex, [in]com::sun::star::util::Date x) raises (SQLException)
 sets the designated parameter to a date value. More...
 
void setTime ([in]long parameterIndex, [in]com::sun::star::util::Time x) raises (SQLException)
 sets the designated parameter to a time value. More...
 
void setTimestamp ([in]long parameterIndex, [in]com::sun::star::util::DateTime x) raises (SQLException)
 sets the designated parameter to a datetime value. More...
 
void setBinaryStream ([in]long parameterIndex, [in]com::sun::star::io::XInputStream x, [in]long length) raises (SQLException)
 sets the designated parameter to the given input stream, which will have the specified number of bytes. More...
 
void setCharacterStream ([in]long parameterIndex, [in]com::sun::star::io::XInputStream x, [in]long length) raises (SQLException)
 sets the designated parameter to the given input stream, which will have the specified number of bytes. More...
 
void setObject ([in]long parameterIndex, [in]any x) raises (SQLException)
 sets the value of a parameter using an any. More...
 
void setObjectWithInfo ([in]long parameterIndex, [in]any x, [in]long targetSqlType, [in]long scale) raises (SQLException)
 set a value from the Datatype ANY for a parameter. More...
 
void setRef ([in]long parameterIndex, [in]XRef x) raises (SQLException)
 sets a REF(&lt;structured-type&gt;) parameter. More...
 
void setBlob ([in]long parameterIndex, [in]XBlob x) raises (SQLException)
 sets a BLOB parameter. More...
 
void setClob ([in]long parameterIndex, [in]XClob x) raises (SQLException)
 sets a CLOB parameter. More...
 
void setArray ([in]long parameterIndex, [in]XArray x) raises (SQLException)
 sets an Array parameter. More...
 
void clearParameters () raises (SQLException)
 clears the current parameter values immediately. 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 Member Functions inherited from XCompletedExecution
void executeWithCompletion ([in]com::sun::star::task::XInteractionHandler handler) raises (com::sun::star::sdbc::SQLException)
 completes necessary information before execution, for example parameter values. More...
 
- Public Member Functions inherited from XRowSetApproveBroadcaster
void addRowSetApproveListener ([in]XRowSetApproveListener listener)
 adds the specified listener to receive the events "approveCursorMove", "approveRowChange", and "appproveRowSetChange". More...
 
void removeRowSetApproveListener ([in]XRowSetApproveListener listener)
 removes the specified listener. More...
 
- Public Member Functions inherited from XResultSetAccess
com::sun::star::sdbc::XResultSet createResultSet () raises (com::sun::star::sdbc::SQLException)
 returns a new com::sun::star::sdbc::ResultSet based on the 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...
 
- Protected Member Functions inherited from XResultSetAccess
com::sun::star::sdbc::XResultSet createResultSet () raises (com::sun::star::sdbc::SQLException)
 returns a new com::sun::star::sdbc::ResultSet based on the object. More...
 
- Protected Member Functions inherited from XParametersSupplier
com::sun::star::container::XIndexAccess getParameters ()
 returns the container of parameters. More...
 

Detailed Description

is a client side RowSet, which use retrieves is data based on a database table, a query or a SQL command or by a row set reader, who mustn't support SQL.

The connection of the row set is typically a named DataSource or a DataAccess component or a previous instantiated connection.

Depending on the com::sun::star::sdbc::ResultSetConcurrency , the RowSet caches all data or uses an optimized way for retrieving the data, such as, refetching rows by their keys or if provided, by their bookmarks.

In addition, it provides events for RowSet navigation and RowSet modifications to approve the actions and to react on them.

See also
com::sun::star::sdb::RowChangeAction
com::sun::star::sdb::RowChangeEvent
com::sun::star::sdb::RowsChangeEvent

Notifications

A row set is able to be operated in various ways, and additionally it notifies various changes in its state. Clients of this service can rely on a fixed order of notifications, depending on how they operate on the component.
The following describes the general order of all possible notifications which you can encounter when working with a row set:

approving Before anything really happens, any veto listeners are called to approve the operation which is just being done. This may be either a XRowSetApproveListener::approveCursorMove() or XRowSetApproveListener::approveRowChange() call.
See also
XRowSetApproveListener
column values If the operation includes changes in the values of the columns of the row set, then these are notified before anything else (except requests for approval).
See also
ResultSet
com::sun::star::sdbcx::XColumnsSupplier
operation done When the operation is done, you get a notification about this. It may be a com::sun::star::sdbc::XRowSetListener::cursorMoved() or a com::sun::star::sdbc::XRowSetListener::rowChanged() call or a XRowsChangeListener::rowsChanged() call.
row state If the operation leads to a change in the state of the IsModified and/or IsNew property, this is notified next (in this order).
row count If the operation leads to new knowledge about the number of rows in the result set, the respective changes in the RowCount and IsRowCountFinal are notified last (in this order).


The following matrix shows the notifications which apply to the different operations:

approveCursorMoveapproveRowChange column values cursorMovedrowChanged rowsChanged IsModifiedIsNew RowCount

IsRowCountFinal

com::sun::star::sdbc::XResultSet

nextXXXXXXX
beforeFirstXXXXX
afterLastXXXXXXX
firstXXXXXXX
lastXXXXXXX
absoluteXXXXXXX
relativeXXXXXXX
previousXXXXXXX
refreshRowXXX
cancelRowUpdatesXX

com::sun::star::sdbc::XResultSetUpdate

insertRowXXXXXXXX
updateRowXXXXX
deleteRowXXXXXXX
moveToInsertRowXXXXX
moveToCurrentRowXXXX

com::sun::star::sdbcx::XDeleteRows

deleteRowsXXXXXX

X

com::sun::star::sdbcx::XRowLocate

moveToBookmarkXXXXX
moveRelativeToBookmarkXXXXXX

X

Deletions

Via com::sun::star::sdbc::XResultSetUpdate::deleteRow(), you can delete the current row of a RowSet. This deleted row then doesn't vanish immediately, but is still present, and subsequent calls to com::sun::star::sdbc::XResultSet::rowDeleted() will return TRUE. The deleted row "vanishes" from the RowSet as soon as the cursor is moved away from it.
As a consequence, the behavior of several other methods is affected:

com::sun::star::sdbc::XResultSet::getRow()

returns the position of the cursor, which has not been changed by the deletion.

com::sun::star::sdbc::XResultSet: next, first, last, absolute, relative, previous, beforeFirst, afterLast

will let the deleted row vanish from the result set. As a consequence, the RowCount will decrease when you do such a move operation after deleting a row.
A special case to note is the next call: When you delete row, say, 15, followed by next, then your RowSet afterwards still is on row 15, since the deleted row vanished with the move operation.

com::sun::star::sdbc::XResultSet::refreshRow()

will throw an exception when the cursor is on a deleted row.

com::sun::star::sdbc::XRow: getFoo

will return an empty value when the cursor is on a deleted row.

com::sun::star::sdbcx::XRowLocate::getBookmark()

will throw an exception when the cursor is on a deleted row.

com::sun::star::sdbc::XRowUpdate: updateFoo

will throw an exception when the cursor is on a deleted row.

com::sun::star::sdbc::XResultSetUpdate::deleteRow()

will throw an exception when the cursor is on a deleted row.

com::sun::star::sdbc::XResultSetUpdate::moveToInsertRow()
will let the deleted row vanish from the result set. As a consequence, the RowCount will decrease. Also, subsequent calls to com::sun::star::sdbc::XResultSetUpdate::moveToCurrentRow() will not be able to move back to the deleted row (since it vanished), but only to the row after the deleted row.
Developers Guide
Forms - Forms as Row Sets
Database - The RowSet Service
Database - Example: Querying the Bibliography Database

Exported Interfaces

Exported Interfaces

can be used to allow an interaction handler to supply missing data during a execute process.

If you want a row set to be based on a parametrized query, you will usually use the com::sun::star::sdbc::XParameters interface.
However, you can also choose to let an interaction handler supply such data. For this, you may for instance instantiate an InteractionHandler, which asks the user for the data, or you may write your own one, which supplies the data from somewhere else. The default implementation will only ask for parameters which aren't set before through the com::sun::star::sdbc::XParameters interface.

See also
com::sun::star::sdb::InteractionHandler

is the interface for updating row data to the database.

The optional support of this interface is already implied with the support of the com::sun::star::sdbc::ResultSet service.

However, note that the additional support of the XRowSetApproveBroadcaster interface results in a semantical extension: the methods com::sun::star::sdbc::XResultSetUpdate::insertRow(), com::sun::star::sdbc::XResultSetUpdate::updateRow() and com::sun::star::sdbc::XResultSetUpdate::deleteRow() will now throw the RowSetVetoException if the action which is to be performed was vetoed by one of the XRowSetApproveListener's.

is the interface for deleting more than one row, identified by its bookmark.

The optional support of this interface is already implied with the support of the com::sun::star::sdbcx::ResultSet service.

However, note that the additional support of the XRowSetApproveBroadcaster interface results in a semantical extension: the method com::sun::star::sdbcx::XDeleteRows::deleteRows() will now throw the RowSetVetoException if the deletion was vetoed by one of the XRowSetApproveListener's.

interface XParametersSupplier
optional

gives access to the parameters contained in the SQL statement represented by the component.

If your RowSet is bound to an SQL command or query which contains parameters, or has a Filter or Order which contains parameters, then those can be accessed using the XParametersSupplier interface.

The returned container contains parameter objects which do allow write access to the parameters (which is equivalent to using the com::sun::star::sdbc::XParameters interface inherited from com::sun::star::sdbc::RowSet). Additionally, they provide information about the parameters, such as their name (if they have one), their type, and the like.

interface XResultSetAccess

creates a second result set which is based on the same data.

The new result set is interoperable with the row set which created it, e.g., you can exchange bookmarks between both sets.

If the row set is not alive (i.e., it was not executed before), NULL is returned.

approving of actions performed on the row set.

The support of this interface implies a semantical extension to the com::sun::star::sdbc::XResultSetUpdate interface which is supported via the com::sun::star::sdbc::ResultSet.

See also
XResultSetUpdate

Member Data Documentation

string ActiveCommand
propertyreadonly

is the command which is currently used.

See also
com::sun::star::sdb::CommandType
com::sun::star::sdbc::XConnection ActiveConnection
property

is the connection generated by a DataSource or by a URL.

It could also be set from outside. When set from outside the RowSet is not responsible for the closing of the connection.

boolean ApplyFilter
property

indicates whether the filter should be applied or not, default is FALSE.

string Command
property

is the command which should be executed, the type of command depends on the CommandType.

In case of a CommandType of CommandType::COMMAND, means in case the Command specifies an SQL statement, the inherited com::sun::star::sdbc::RowSet::EscapeProcessing becomes relevant:
It then can be to used to specify whether the SQL statement should be analyzed on the client side before sending it to the database server.
The default value for com::sun::star::sdbc::RowSet::EscapeProcessing is TRUE. By switching it to FALSE, you can pass backend-specific SQL statements, which are not standard SQL, to your database.

See also
com::sun::star::sdb::CommandType
com::sun::star::sdbc::RowSet::EscapeProcessing
long CommandType
property

is the type of the command.

See also
com::sun::star::sdb::CommandType
string DataSourceName
property

is the name of the datasource to use, this could be a named datasource or the URL of a data access component.

string Filter
property

additional filter for a row set.

string GroupBy
optionalproperty

additional group by for the row set

string HavingClause
optionalproperty

additional having clause for the row set

boolean IgnoreResult
property

indicates whether all results should be discarded or not.

boolean IsModified
propertyreadonly

indicates that the current row is modified.

boolean IsNew
propertyreadonly

indicates that the current row is going to be inserted to the database.

boolean IsRowCountFinal
propertyreadonly

indicates that all rows of the row set have been counted.

string Order
property

is a additional sort order definition for a row set.

long Privileges
propertyreadonly

indicates the privileges for insert, update, and delete.

See also
com::sun::star::sdbcx::Privilege
long RowCount
propertyreadonly

contains the number of rows accessed in a the data source.

string UpdateCatalogName
optionalproperty

is the name of the table catalog

string UpdateSchemaName
optionalproperty

is the name of the table schema.

string UpdateTableName
optionalproperty

is the name of the table which should be updated, this is usually used for queries which relate to more than one table.


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