Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

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 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
See also
com::sun::star::sdb::RowChangeEvent



Included Services

com::sun::star::sdbc::RowSet
Description
is a client side ResultSet, which combines the characteristics of a Statement and a ResultSet .
com::sun::star::sdb::ResultSet
Description
extends the ResultSet by a more sophisticated access to the result sets data.

Exported Interfaces

com::sun::star::sdb::XRowSetApproveBroadcaster
Description
approving of actions performed on the rowset.
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

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.
DataSourceName is the name of the datasource to use, this could be a named datasource or the URL of a data access component.
Command is the command which should be executed, the type of command depends on the CommandType.
CommandType is the type of the command.
ActiveCommand is the command which is currently used.
IgnoreResult indicates whether all results should be discarded or not.
Filter additional filter for a rowset.
ApplyFilter indicates whether the filter should be applied or not, default is false .
Order is a additional sort order definition for a rowset.
Privileges indicates the privileges for insert, update, and delete.
IsModified indicates that the current row is modified.
IsNew indicates that the current row is going to be inserted to the database.
RowCount contains the number of rows accessed in a the data source.
IsRowCountFinal indicates that all rows of te row set have been counted.
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. @optional
UpdateCatalogName [ OPTIONAL ]
is the name of the table catalog @optional
UpdateSchemaName [ OPTIONAL ]
is the name of the table schema. @optional

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.
See also
com::sun::star::sdb::CommandType
CommandType
 
long CommandType;
Description
is the type of the command.
See also
com::sun::star::sdb::CommandType
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 .
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;
[ 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. @optional
UpdateCatalogName
 
string UpdateCatalogName;
[ OPTIONAL ]
Description
is the name of the table catalog @optional
UpdateSchemaName
 
string UpdateSchemaName;
[ OPTIONAL ]
Description
is the name of the table schema. @optional

Top of Page