:: com :: sun :: star :: sdb ::

service RowSet
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 rowset reader, who mustn't support SQL. The connection of the rowset is typically a named DataSource or a DataAccess component or a previous instanciated 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::XRowSetApproveListener, ::com::sun::star::sdb::ResultSet, ::com::sun::star::sdbcx::XColumnsSupplier
Developers Guide
Included Services
::com::sun::star::sdbc::RowSet
(referenced entity's summary:)
is a client side ResultSet, which combines the characteristics of a ::com::sun::star::sdbc::Statement and a ::com::sun::star::sdbc::ResultSet .
::com::sun::star::sdb::ResultSet
(referenced entity's summary:)
extends the ::com::sun::star::sdbcx::ResultSet by a more sophisticated access to the result sets data.
Exported Interfaces
::com::sun::star::sdb::XCompletedExecution
Description
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 ::com::sun::star::sdb::InteractionHandler , which asks the user for the data, or you may write your own one, which supplies the data from somewhere else.

See also
::com::sun::star::sdb::InteractionHandler
::com::sun::star::sdb::XRowSetApproveBroadcaster
Description
approving of actions performed on the rowset.

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

See also
XResultSetUpdate
::com::sun::star::sdbc::XResultSetUpdate
Usage Restrictions
optional
Description
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 ::com::sun::star::sdb::XRowSetApproveBroadcaster interface results in a sematical 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 ::com::sun::star::sdb::RowSetVetoException if the action which is to be performed was vetoed by one of the ::com::sun::star::sdb::XRowSetApproveListener 's.

::com::sun::star::sdbcx::XDeleteRows
Usage Restrictions
optional
Description
is the interface for deleting more than one row, identified by it's 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 ::com::sun::star::sdb::XRowSetApproveBroadcaster interface results in a sematical extension: the method ::com::sun::star::sdbcx::XDeleteRows::deleteRows will now throw the ::com::sun::star::sdb::RowSetVetoException if the deletion was vetoed by one of the ::com::sun::star::sdb::XRowSetApproveListener 's.

::com::sun::star::sdb::XResultSetAccess
Description
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.

Properties' Summary
::com::sun::star::sdbc::XConnection
ActiveConnection
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.  
string
DataSourceName
is the name of the datasource to use, this could be a named datasource or the URL of a data access component.  
string
Command
is the command which should be executed, the type of command depends on the CommandType.  
long
CommandType
is the type of the command.  
[ readonly ] string
ActiveCommand
is the command which is currently used.  
boolean
IgnoreResult
indicates whether all results should be discarded or not.  
string
Filter
additional filter for a rowset.  
boolean
ApplyFilter
indicates whether the filter should be applied or not, default is false .  
string
HavingClause
[ OPTIONAL ]
additional having clause for the row set  
string
GroupBy
[ OPTIONAL ]
additional group by for the row set  
string
Order
is a additional sort order definition for a rowset.  
[ readonly ] long
Privileges
indicates the privileges for insert, update, and delete.  
[ readonly ] boolean
IsModified
indicates that the current row is modified.  
[ readonly ] boolean
IsNew
indicates that the current row is going to be inserted to the database.  
[ readonly ] long
RowCount
contains the number of rows accessed in a the data source.  
[ readonly ] boolean
IsRowCountFinal
indicates that all rows of te row set have been counted.  
string
UpdateTableName
[ OPTIONAL ]
is the name of the table which should be updated, this is usually used for queries which relate to more than one table.  
string
UpdateCatalogName
[ OPTIONAL ]
is the name of the table catalog  
string
UpdateSchemaName
[ OPTIONAL ]
is the name of the table schema.  
Properties' Details
ActiveConnection
::com::sun::star::sdbc::XConnection ActiveConnection;
Description
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.
DataSourceName
string DataSourceName;
Description
is the name of the datasource to use, this could be a named datasource or the URL of a data access component.
Command
string Command;
Description
is the command which should be executed, the type of command depends on the CommandType.

In case of a CommandType of ::com::sun::star::sdb::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
CommandType
long CommandType;
Description
is the type of the command.
See also
::com::sun::star::sdb::CommandType
ActiveCommand
[ readonly ] string ActiveCommand;
Description
is the command which is currently used.
See also
::com::sun::star::sdb::CommandType
IgnoreResult
boolean IgnoreResult;
Description
indicates whether all results should be discarded or not.
Filter
string Filter;
Description
additional filter for a rowset.
ApplyFilter
boolean ApplyFilter;
Description
indicates whether the filter should be applied or not, default is false .
HavingClause
string HavingClause;
Usage Restrictions
optional
Description
additional having clause for the row set
GroupBy
string GroupBy;
Usage Restrictions
optional
Description
additional group by for the row set
Order
string Order;
Description
is a additional sort order definition for a rowset.
Privileges
[ readonly ] long Privileges;
Description
indicates the privileges for insert, update, and delete.
See also
::com::sun::star::sdbcx::Privilege
IsModified
[ readonly ] boolean IsModified;
Description
indicates that the current row is modified.
IsNew
[ readonly ] boolean IsNew;
Description
indicates that the current row is going to be inserted to the database.
RowCount
[ readonly ] long RowCount;
Description
contains the number of rows accessed in a the data source.
IsRowCountFinal
[ readonly ] boolean IsRowCountFinal;
Description
indicates that all rows of te row set have been counted.
UpdateTableName
string UpdateTableName;
Usage Restrictions
optional
Description
is the name of the table which should be updated, this is usually used for queries which relate to more than one table.
UpdateCatalogName
string UpdateCatalogName;
Usage Restrictions
optional
Description
is the name of the table catalog
UpdateSchemaName
string UpdateSchemaName;
Usage Restrictions
optional
Description
is the name of the table schema.

 
Top of Page