LibreOffice
LibreOffice 6.4 SDK API Reference
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 #ifndef __com_sun_star_sdb_DataSource_idl__
20 #define __com_sun_star_sdb_DataSource_idl__
21 
23 
25 
27 
29 
31 
32 
33  module com { module sun { module star { module sdbc {
34  published interface XIsolatedConnection;
35  published interface XDataSource;
36  };};};};
37 
38 
39  module com { module sun { module star { module sdb {
40 
41  published interface XCompletedConnection;
42  published interface XQueryDefinitionsSupplier;
43  published interface XBookmarksSupplier;
44 
45 
50 published service DataSource
51 {
53 
54 
59 
67 
68 
72 
73 
84 
85  /* useful for establishing connections and to get and set the login timeout.
86  */
88 
98  [optional] interface XBookmarksSupplier;
99 
109  [readonly, property] string Name;
110 
111 
117  [property] string URL;
118 
119 
137  [property] sequence<com::sun::star::beans::PropertyValue> Info;
138 
185  [property, readonly, optional] com::sun::star::beans::XPropertySet Settings;
186 
189  [property] string User;
190 
191 
194  [property] string Password;
195 
196 
199  [property] boolean IsPasswordRequired;
200 
201 
205  [property] boolean SuppressVersionColumns;
206 
207 
210  [readonly, property] boolean IsReadOnly;
211 
212 
217 
218 
223  [property] sequence<string> TableFilter;
224 
225 
230  [property] sequence<string> TableTypeFilter;
231 };
232 
233 
234 }; }; }; };
235 
236 #endif
237 
238 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:64
com::sun::star::sdb::DataSource::TableTypeFilter
sequence< string > TableTypeFilter
defines a list of table types, on which the DataSource should have it's focus.
Definition: DataSource.idl:230
com::sun::star::sdb::DataSource::User
string User
determines a users login name.
Definition: DataSource.idl:189
com::sun::star::sdbc::XDataSource
is used for establishing connections via a factory which is identified by its name.
Definition: XDataSource.idl:36
com::sun::star::sdb::DataSource
is a factory to establish database connections.
Definition: DataSource.idl:51
com::sun::star::sdb::DataSource::IsPasswordRequired
boolean IsPasswordRequired
indicates that a password is always necessary.
Definition: DataSource.idl:199
com::sun::star::sdb::DataSource::NumberFormatsSupplier
com::sun::star::util::XNumberFormatsSupplier NumberFormatsSupplier
provides an object for formatting numbers.
Definition: DataSource.idl:216
XFlushable.idl
com::sun::star::sdb::DataSource::TableFilter
sequence< string > TableFilter
defines a list of tables, on which the DataSource should have it's focus.
Definition: DataSource.idl:223
com::sun::star::sdb::XQueryDefinitionsSupplier
provides the access to a container of database command definitions.
Definition: XQueryDefinitionsSupplier.idl:32
com::sun::star::util::XNumberFormatsSupplier
supplies the collection of NumberFormats (for example, in a document) and the settings belonging to t...
Definition: XNumberFormatsSupplier.idl:37
com::sun::star::sdbc::XIsolatedConnection
is used for establishing isolated connections via a factory.
Definition: XIsolatedConnection.idl:38
com::sun::star::sdb::DataSource::IsReadOnly
boolean IsReadOnly
determines whether modifications on the data source are allowed or not.
Definition: DataSource.idl:210
com::sun::star::sdb::DataSource::Settings
com::sun::star::beans::XPropertySet Settings
is a convenience wrapper around the Info property.
Definition: DataSource.idl:185
XNumberFormatsSupplier.idl
com::sun::star::sdb::DataSource::URL
string URL
indicates a database url of the form jdbc:subprotocol:subname or sdbc:subprotocol:subname
Definition: DataSource.idl:117
PropertyValue.idl
com::sun::star::sdb::XBookmarksSupplier
provides access to the collection of all bookmarks associated with a data source.
Definition: XBookmarksSupplier.idl:34
XPersistObject.idl
com::sun::star::util::XFlushable
is supported by objects with data that can be flushed to a data source.
Definition: XFlushable.idl:34
XPropertySet.idl
com
Definition: Ambiguous.idl:22
com::sun::star::sdb::DataSource::Name
string Name
is the name of the data source.
Definition: DataSource.idl:98
com::sun::star::sdb::DataSource::Info
sequence< com::sun::star::beans::PropertyValue > Info
is a list of arbitrary string tag/value pairs as connection arguments
Definition: DataSource.idl:137
com::sun::star::sdb::XCompletedConnection
is used for establishing connections via a factory which is identified by its name.
Definition: XCompletedConnection.idl:38
com::sun::star::sdb::DataSource::SuppressVersionColumns
boolean SuppressVersionColumns
indicates that components displaying data obtained from this data source should suppress columns used...
Definition: DataSource.idl:205
com::sun::star::sdb::DataSource::Password
string Password
determines a users password.
Definition: DataSource.idl:194