LibreOffice
LibreOffice 6.4 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 #ifndef __com_sun_star_sdb_RowSet_idl__
20 #define __com_sun_star_sdb_RowSet_idl__
21 
23 
24 module com { module sun { module star { module sdbc {
25 published interface XConnection;
26 };};};};
29 
30  module com { module sun { module star { module sdbcx {
31 published interface XDeleteRows;
32 };};};};
33 
34  module com { module sun { module star { module sdb {
35 
36 published interface XRowSetApproveBroadcaster;
37 published interface XResultSetAccess;
38 published interface XParametersSupplier;
39 
40 
191 published service RowSet
192 {
194 
196 
209 
218 
230 
241 
253  interface XResultSetAccess;
254 
266  [optional] interface XParametersSupplier;
267 
272 
273 
277  [property] string DataSourceName;
278 
279 
296  [property] string Command;
297 
301  [property] long CommandType;
302 
306  [readonly, property] string ActiveCommand;
307 
308 
311  [property] boolean IgnoreResult;
312 
313 
316  [property] string Filter;
317 
318 
322  [property] boolean ApplyFilter;
323 
326  [optional,property] string HavingClause;
327 
330  [optional,property] string GroupBy;
331 
334  [property] string Order;
335 
336 
340  [readonly, property] long Privileges;
341 
342 
345  [readonly, property] boolean IsModified;
346 
347 
350  [readonly, property] boolean IsNew;
351 
352 
355  [readonly, property] long RowCount;
356 
357 
360  [readonly, property] boolean IsRowCountFinal;
361 
362 
366  [optional, property] string UpdateTableName;
367 
370  [optional, property] string UpdateCatalogName;
371 
372 
375  [optional, property] string UpdateSchemaName;
376 };
377 
378 
379 }; }; }; };
380 
381 /*===========================================================================
382 ===========================================================================*/
383 #endif
384 
385 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::sdb::RowSet::Order
string Order
is an additional sort order definition for a row set.
Definition: RowSet.idl:334
com::sun::star::sdb::RowSet::Privileges
long Privileges
indicates the privileges for insert, update, and delete.
Definition: RowSet.idl:340
com::sun::star::sdb::RowSet::IsRowCountFinal
boolean IsRowCountFinal
indicates that all rows of the row set have been counted.
Definition: RowSet.idl:360
ResultSet.idl
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:277
com::sun::star::sdb::RowSet::UpdateCatalogName
string UpdateCatalogName
is the name of the table catalog
Definition: RowSet.idl:370
com::sun::star::sdbc::XConnection
represents a connection (session) with a specific database.
Definition: XConnection.idl:58
com::sun::star::sdb::RowSet::HavingClause
string HavingClause
additional having clause for the row set
Definition: RowSet.idl:326
com::sun::star::sdb::RowSet::UpdateSchemaName
string UpdateSchemaName
is the name of the table schema.
Definition: RowSet.idl:375
com::sun::star::sdb::RowSet::GroupBy
string GroupBy
additional group by for the row set
Definition: RowSet.idl:330
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:266
XCompletedExecution.idl
com::sun::star::sdb::RowSet::Filter
string Filter
additional filter for a row set.
Definition: RowSet.idl:316
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:41
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:37
com::sun::star::sdb::RowSet::ActiveCommand
string ActiveCommand
is the command which is currently used.
Definition: RowSet.idl:306
RowSet.idl
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:58
com::sun::star::sdb::RowSet::RowCount
long RowCount
contains the number of rows accessed in the data source.
Definition: RowSet.idl:355
com::sun::star::sdb::RowSet::IgnoreResult
boolean IgnoreResult
indicates whether all results should be discarded or not.
Definition: RowSet.idl:311
com
Definition: Ambiguous.idl:22
com::sun::star::sdb::XCompletedExecution
is used for execution where information for execution may be required from the user.
Definition: XCompletedExecution.idl:33
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:296
com::sun::star::sdb::RowSet::CommandType
long CommandType
is the type of the command.
Definition: RowSet.idl:301
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:192
com::sun::star::sdb::RowSet::IsModified
boolean IsModified
indicates that the current row is modified.
Definition: RowSet.idl:345
com::sun::star::sdbc::XResultSetUpdate
provides the possibility to write changes made on a result set back to database.
Definition: XResultSetUpdate.idl:33
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:366
com::sun::star::sdb::RowSet::IsNew
boolean IsNew
indicates that the current row is going to be inserted to the database.
Definition: RowSet.idl:350
com::sun::star::sdbcx::XDeleteRows
provides for the deletion of more than one row at a time.
Definition: XDeleteRows.idl:32
com::sun::star::sdb::RowSet::ApplyFilter
boolean ApplyFilter
indicates whether the filter should be applied or not, default is FALSE.
Definition: RowSet.idl:322
com::sun::star::sdb::XRowSetApproveBroadcaster
provides the possibility of reviving an event before changing the content of a row set.
Definition: XRowSetApproveBroadcaster.idl:33
com::sun::star::sdb::XParametersSupplier
provides the access to a container of parameters, typically used for a prepared statement.
Definition: XParametersSupplier.idl:33