summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdb/DataSource.idl
blob: 7c25d755af7e7caf27f938e5e66b7b0b304f8ee7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/*************************************************************************
 *
 *  $RCSfile: DataSource.idl,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: mi $ $Date: 2000-11-06 13:16:22 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_sdb_DataSource_idl__
#define __com_sun_star_sdb_DataSource_idl__

#ifndef __com_sun_star_io_XPersistObject_idl__
#include <com/sun/star/io/XPersistObject.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

#ifndef __com_sun_star_util_XFlushable_idl__
#include <com/sun/star/util/XFlushable.idl>
#endif

#ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
#include <com/sun/star/util/XNumberFormatsSupplier.idl>
#endif


 module com {  module sun {  module star {  module sdb {

interface XCompletedConnection;
interface XFormDocumentsSupplier;
interface XReportDocumentsSupplier;
interface XQueryDefinitionsSupplier;


// DocMerge from xml: service com::sun::star::sdb::DataSource
/** is a factory to establish database connections. It should be registered at
    a NamingService.@see com::sun::star::sdb::DatabaseContext
 */
service DataSource
{
    // DocMerge: empty anyway
    interface com::sun::star::beans::XPropertySet;


    // DocMerge from xml: service com::sun::star::sdb::DataSource: interface com::sun::star::sdb::XCompletedConnection
    /** useful for establishing connections with the completion of connection parameters
                provided during user interaction.
     */
    interface XCompletedConnection;


    // DocMerge from xml: service com::sun::star::sdb::DataSource: interface com::sun::star::util::XFlushable
    /** is provided to flush a DataSource within to a Database Context.
     */
    interface com::sun::star::util::XFlushable;


    // DocMerge from xml: service com::sun::star::sdb::DataSource: interface com::sun::star::sdb::XFormDocumentsSupplier
    /** provides the access to DataSource related forms.
     */
    interface XFormDocumentsSupplier;


    // DocMerge from xml: service com::sun::star::sdb::DataSource: interface com::sun::star::sdb::XReportDocumentsSupplier
    /** provides the access to DataSource related reports.
     */
    interface XReportDocumentsSupplier;


    // DocMerge from xml: service com::sun::star::sdb::DataSource: interface com::sun::star::sdb::XQueryDefinitionsSupplier
    /** provides the access to DataSource related queries.
     */
    interface XQueryDefinitionsSupplier;


    // DocMerge from xml: property com::sun::star::sdb::DataSource::Name
    /** is the name of the data source.
     */
    [readonly, property] string Name;


    // DocMerge from xml: property com::sun::star::sdb::DataSource::URL
    /** indicates a database url of the form <br>
        <code> jdbc:<em>subprotocol</em>:<em>subname</em></code> or
        <code> sdbc:<em>subprotocol</em>:<em>subname</em></code>
     */
    [property] string URL;


    // DocMerge from idl: property com::sun::star::sdb::DataSource::Info
    /** is a list of arbitrary string tag/value pairs as
             connection arguments; normally at least a "user" and
             "password" property should be included.
     */
    [property] sequence<com::sun::star::beans::PropertyValue> Info;


    // DocMerge from xml: property com::sun::star::sdb::DataSource::User
    /** determines a users login name.
     */
    [property] string User;


    // DocMerge from xml: property com::sun::star::sdb::DataSource::Password
    /** determines a users password. The password is not persistent.
     */
    [property] string Password;


    // DocMerge from xml: property com::sun::star::sdb::DataSource::IsPasswordRequired
    /** indicates that a password is always necessary.
     */
    [property] boolean IsPasswordRequired;


    /** indicates that components displaying data obtained from this data source should suppress columns used for versioning.
     */
    [property] boolean SuppressVersionColumns;


    // DocMerge from xml: property com::sun::star::sdb::DataSource::IsReadOnly
    /** determines whether modifications on the data source are are allowed
        or not.
     */
    [readonly, property] boolean IsReadOnly;


    // DocMerge from xml: property com::sun::star::sdb::DataSource::NumberFormatsSupplier
    /** provides an object for formatting numbers.
     */
    [readonly, property] com::sun::star::util::XNumberFormatsSupplier
                        NumberFormatsSupplier;


    // DocMerge from idl: property com::sun::star::sdb::DataSource::TableFilter
    /** defines a list of tables, on which the DataSource should have it's focus.
             If empty, all the tables of the are used.
     */
    [property] sequence<string> TableFilter;


    // DocMerge from idl: property com::sun::star::sdb::DataSource::TableTypeFilter
    /** defines a list of table types, on which the DataSource should have it's focus.
             If empty, all the tables types of the are used.
     */
    [property] sequence<string> TableTypeFilter;
};

//=============================================================================

}; }; }; };

/*===========================================================================
    $Log: not supported by cvs2svn $
    Revision 1.2  2000/10/20 09:42:58  fs
    new property SuppressVersionColumns

    Revision 1.1.1.1  2000/09/18 23:35:36  hjs
    initial import

    Revision 1.8  2000/09/11 11:52:39  mi
    documentation merged from XML

    Revision 1.6  2000/07/05 17:12:07  os
    wrong property name corrected: NumberFormats -> NumberFormatsSupplier

    Revision 1.5  2000/06/27 06:57:50  dg
    CommandPreparation new

    Revision 1.4  2000/06/08 08:31:08  dg
    XDatabaseAccess is no longer part of the DataSource

    Revision 1.3  2000/06/05 13:35:37  dg
    services changed

    Revision 1.2  2000/06/05 13:20:27  dg
    services changed

    Revision 1.1  1999/11/24 08:39:00  dg
    new Star Data Beans

===========================================================================*/
#endif