service RowSet in module com::sun::star::sdb::

(Global Index)

Syntax

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

RowChangeAction

See also

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.


Property 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 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 is the name of the table catalog @optional

UpdateSchemaName is the name of the table schema. @optional

Property Details



ActiveConnection

Syntax

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

Syntax

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

Syntax

string Command;

Description

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

See also

CommandType

CommandType

Syntax

long CommandType;

Description

is the type of the command.

See also

CommandType

See also

CommandType

ActiveCommand

Syntax

[readonly] string ActiveCommand;

Description

is the command which is currently used.

See also

CommandType

IgnoreResult

Syntax

boolean IgnoreResult;

Description

indicates whether all results should be discarded or not.


Filter

Syntax

string Filter;

Description

additional filter for a rowset.


ApplyFilter

Syntax

boolean ApplyFilter;

Description

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


Order

Syntax

string Order;

Description

is a additional sort order definition for a rowset.


Privileges

Syntax

[readonly] long Privileges;

Description

indicates the privileges for insert, update, and delete.

See also

Privilege

IsModified

Syntax

[readonly] boolean IsModified;

Description

indicates that the current row is modified.


IsNew

Syntax

[readonly] boolean IsNew;

Description

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


RowCount

Syntax

[readonly] long RowCount;

Description

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


IsRowCountFinal

Syntax

[readonly] boolean IsRowCountFinal;

Description

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


UpdateTableName [ O P T I O N A L ]

Syntax

string UpdateTableName;

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 [ O P T I O N A L ]

Syntax

string UpdateCatalogName;

Description

is the name of the table catalog @optional


UpdateSchemaName [ O P T I O N A L ]

Syntax

string UpdateSchemaName;

Description

is the name of the table schema. @optional

Top of Page