LibreOffice
LibreOffice 24.8 SDK API Reference
 
Loading...
Searching...
No Matches
DataSource.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
20
21 module com { module sun { module star { module sdbc {
22 published interface XIsolatedConnection;
23 published interface XDataSource;
24 };};};};
25
26
27 module com { module sun { module star { module sdb {
28
29 published interface XCompletedConnection;
30 published interface XQueryDefinitionsSupplier;
31 published interface XBookmarksSupplier;
32
33
38published service DataSource
39{
41
42
47
55
56
60
61
72
73 /* useful for establishing connections and to get and set the login timeout.
74 */
76
86 [optional] interface XBookmarksSupplier;
87
97 [readonly, property] string Name;
98
99
105 [property] string URL;
106
107
125 [property] sequence<com::sun::star::beans::PropertyValue> Info;
126
173 [property, readonly, optional] com::sun::star::beans::XPropertySet Settings;
174
177 [property] string User;
178
179
182 [property] string Password;
183
184
187 [property] boolean IsPasswordRequired;
188
189
193 [property] boolean SuppressVersionColumns;
194
195
198 [readonly, property] boolean IsReadOnly;
199
200
205
206
211 [property] sequence<string> TableFilter;
212
213
218 [property] sequence<string> TableTypeFilter;
219};
220
221
222}; }; }; };
223
224/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
provides information about and access to the properties from an implementation.
Definition XPropertySet.idl:46
is used for establishing connections via a factory which is identified by its name.
Definition XDataSource.idl:30
is used for establishing isolated connections via a factory.
Definition XIsolatedConnection.idl:32
is supported by objects with data that can be flushed to a data source.
Definition XFlushable.idl:28
supplies the collection of NumberFormats (for example, in a document) and the settings belonging to t...
Definition XNumberFormatsSupplier.idl:29
Definition Ambiguous.idl:20
is a factory to establish database connections.
Definition DataSource.idl:39
interface XQueryDefinitionsSupplier
provides the access to DataSource related queries.
Definition DataSource.idl:71
interface XBookmarksSupplier
provides access to bookmarks to documents associated with the data source
Definition DataSource.idl:86
sequence< string > TableTypeFilter
defines a list of table types, on which the DataSource should have it's focus.
Definition DataSource.idl:218
boolean IsPasswordRequired
indicates that a password is always necessary.
Definition DataSource.idl:187
sequence< com::sun::star::beans::PropertyValue > Info
is a list of arbitrary string tag/value pairs as connection arguments
Definition DataSource.idl:125
string Name
is the name of the data source.
Definition DataSource.idl:97
interface XCompletedConnection
useful for establishing connections with the completion of connection parameters provided during user...
Definition DataSource.idl:46
string Password
determines a users password.
Definition DataSource.idl:182
string User
determines a users login name.
Definition DataSource.idl:177
com::sun::star::beans::XPropertySet Settings
is a convenience wrapper around the Info property.
Definition DataSource.idl:173
boolean IsReadOnly
determines whether modifications on the data source are allowed or not.
Definition DataSource.idl:198
com::sun::star::util::XNumberFormatsSupplier NumberFormatsSupplier
provides an object for formatting numbers.
Definition DataSource.idl:204
sequence< string > TableFilter
defines a list of tables, on which the DataSource should have it's focus.
Definition DataSource.idl:211
boolean SuppressVersionColumns
indicates that components displaying data obtained from this data source should suppress columns used...
Definition DataSource.idl:193
string URL
indicates a database url of the form jdbc:subprotocol:subname or sdbc:subprotocol:subname
Definition DataSource.idl:105