LibreOffice LibreOffice 25.2 SDK API Reference

RowSet.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20module com { module sun { module star { module sdbc {
21published interface XConnection;
22};};};};
23
24 module com { module sun { module star { module sdbcx {
25published interface XDeleteRows;
26};};};};
27
28 module com { module sun { module star { module sdb {
29
30published interface XRowSetApproveBroadcaster;
31published interface XResultSetAccess;
32published interface XParametersSupplier;
33
34
185published service RowSet
186{
187 service com::sun::star::sdbc::RowSet;
188
189 service com::sun::star::sdb::ResultSet;
190
202 interface com::sun::star::sdb::XCompletedExecution;
203
211 interface XRowSetApproveBroadcaster;
212
223 [optional] interface com::sun::star::sdbc::XResultSetUpdate;
224
234 [optional] interface com::sun::star::sdbcx::XDeleteRows;
235
247 interface XResultSetAccess;
248
260 [optional] interface XParametersSupplier;
261
265 [property] com::sun::star::sdbc::XConnection ActiveConnection;
266
267
271 [property] string DataSourceName;
272
273
290 [property] string Command;
291
295 [property] long CommandType;
296
300 [readonly, property] string ActiveCommand;
301
302
305 [property] boolean IgnoreResult;
306
307
310 [property] string Filter;
311
312
316 [property] boolean ApplyFilter;
317
320 [optional,property] string HavingClause;
321
324 [optional,property] string GroupBy;
325
328 [property] string Order;
329
330
334 [readonly, property] long Privileges;
335
336
339 [readonly, property] boolean IsModified;
340
341
344 [readonly, property] boolean IsNew;
345
346
349 [readonly, property] long RowCount;
350
351
354 [readonly, property] boolean IsRowCountFinal;
355
356
360 [optional, property] string UpdateTableName;
361
364 [optional, property] string UpdateCatalogName;
365
366
369 [optional, property] string UpdateSchemaName;
370};
371
372
373}; }; }; };
374
375/*===========================================================================
376===========================================================================*/
377
378/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::sdb::XCompletedExecution
is used for execution where information for execution may be required from the user.
Definition: XCompletedExecution.idl:27
com::sun::star::sdb::XParametersSupplier
provides the access to a container of parameters, typically used for a prepared statement.
Definition: XParametersSupplier.idl:27
com::sun::star::sdb::XResultSetAccess
is the interface to create a com::sun::star::sdbc::ResultSet based on the object providing the interf...
Definition: XResultSetAccess.idl:35
com::sun::star::sdb::XRowSetApproveBroadcaster
provides the possibility of reviving an event before changing the content of a row set.
Definition: XRowSetApproveBroadcaster.idl:29
com::sun::star::sdbc::XConnection
represents a connection (session) with a specific database.
Definition: XConnection.idl:50
com::sun::star::sdbc::XResultSetUpdate
provides the possibility to write changes made on a result set back to database.
Definition: XResultSetUpdate.idl:27
com::sun::star::sdbcx::XDeleteRows
provides for the deletion of more than one row at a time.
Definition: XDeleteRows.idl:26
com
Definition: Ambiguous.idl:20
com::sun::star::sdb::ResultSet
extends the com::sun::star::sdbcx::ResultSet by a more sophisticated access to the result sets data.
Definition: ResultSet.idl:33
com::sun::star::sdb::RowSet
is a client side RowSet, which use retrieves is data based on a database table, a query or a SQL comm...
Definition: RowSet.idl:186
com::sun::star::sdb::RowSet::CommandType
long CommandType
is the type of the command.
Definition: RowSet.idl:295
com::sun::star::sdb::RowSet::GroupBy
string GroupBy
additional group by for the row set
Definition: RowSet.idl:324
com::sun::star::sdb::RowSet::UpdateSchemaName
string UpdateSchemaName
is the name of the table schema.
Definition: RowSet.idl:369
com::sun::star::sdb::RowSet::Filter
string Filter
additional filter for a row set.
Definition: RowSet.idl:310
com::sun::star::sdb::RowSet::ApplyFilter
boolean ApplyFilter
indicates whether the filter should be applied or not, default is FALSE.
Definition: RowSet.idl:316
com::sun::star::sdb::RowSet::Order
string Order
is an additional sort order definition for a row set.
Definition: RowSet.idl:328
com::sun::star::sdb::RowSet::ActiveCommand
string ActiveCommand
is the command which is currently used.
Definition: RowSet.idl:300
com::sun::star::sdb::RowSet::IgnoreResult
boolean IgnoreResult
indicates whether all results should be discarded or not.
Definition: RowSet.idl:305
com::sun::star::sdb::RowSet::Command
string Command
is the command which should be executed, the type of command depends on the CommandType.
Definition: RowSet.idl:290
com::sun::star::sdb::RowSet::Privileges
long Privileges
indicates the privileges for insert, update, and delete.
Definition: RowSet.idl:334
com::sun::star::sdb::RowSet::ActiveConnection
com::sun::star::sdbc::XConnection ActiveConnection
is the connection generated by a DataSource or by a URL.
Definition: RowSet.idl:260
com::sun::star::sdb::RowSet::HavingClause
string HavingClause
additional having clause for the row set
Definition: RowSet.idl:320
com::sun::star::sdb::RowSet::IsRowCountFinal
boolean IsRowCountFinal
indicates that all rows of the row set have been counted.
Definition: RowSet.idl:354
com::sun::star::sdb::RowSet::UpdateTableName
string UpdateTableName
is the name of the table which should be updated, this is usually used for queries which relate to mo...
Definition: RowSet.idl:360
com::sun::star::sdb::RowSet::UpdateCatalogName
string UpdateCatalogName
is the name of the table catalog
Definition: RowSet.idl:364
com::sun::star::sdb::RowSet::DataSourceName
string DataSourceName
is the name of the datasource to use, this could be a named datasource or the URL of a data access co...
Definition: RowSet.idl:271
com::sun::star::sdb::RowSet::IsNew
boolean IsNew
indicates that the current row is going to be inserted to the database.
Definition: RowSet.idl:344
com::sun::star::sdb::RowSet::IsModified
boolean IsModified
indicates that the current row is modified.
Definition: RowSet.idl:339
com::sun::star::sdb::RowSet::RowCount
long RowCount
contains the number of rows accessed in the data source.
Definition: RowSet.idl:349
com::sun::star::sdbc::RowSet
is a client side ResultSet, which combines the characteristics of a com::sun::star::sdbc::Statement a...
Definition: RowSet.idl:53