xref: /AOO41X/main/offapi/com/sun/star/sdb/DatabaseAccess.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_sdb_DatabaseAccess_idl__
24#define __com_sun_star_sdb_DatabaseAccess_idl__
25
26#ifndef __com_sun_star_beans_XPropertySet_idl__
27#include <com/sun/star/beans/XPropertySet.idl>
28#endif
29
30#ifndef __com_sun_star_beans_PropertyValue_idl__
31#include <com/sun/star/beans/PropertyValue.idl>
32#endif
33
34#ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
35#include <com/sun/star/util/XNumberFormatsSupplier.idl>
36#endif
37
38
39 module com {  module sun {  module star {  module sdb {
40
41 published interface XDatabaseAccess;
42 published interface XCompletedConnection;
43
44
45/** specifies a component, which controls DatabaseAccessConnections and acts like a
46    shared DataSource.
47
48    @deprecated
49 */
50published service DatabaseAccess
51{
52    // gives access to the properties.
53    interface com::sun::star::beans::XPropertySet;
54
55    /** controls the establishing of the connections.
56     */
57    interface XDatabaseAccess;
58
59    /** establishing a connection with user interaction, the implementation
60             is optional.
61     */
62    [optional] interface XCompletedConnection;
63
64    /** is the URL of the bean.
65     */
66    [readonly, property] string URL;
67
68    /** is the title of the bean.
69     */
70    [property] string Title;
71
72    /** indicates a database url of the form <br>
73        <code> jdbc:<em>subprotocol</em>:<em>subname</em></code> or
74        <code> sdbc:<em>subprotocol</em>:<em>subname</em></code>
75     */
76    [property] string ConnectURL;
77
78    /** is a list of arbitrary string tag/value pairs as
79             connection arguments; normally at least a "user" and
80             "password" property should be included.
81     */
82    [property] sequence<com::sun::star::beans::PropertyValue> ConnectInfo;
83
84    /** determines whether modifications on the data access bean are allowed
85        or not.
86     */
87    [readonly, property] boolean IsReadOnly;
88
89    /** provides an object for formatting numbers.
90     */
91    [property] com::sun::star::util::XNumberFormatsSupplier
92                        NumberFormatsSupplier;
93
94    /** indicates that a password is always necessary.
95     */
96    [optional, property] boolean IsPasswordRequired;
97
98    /** defines a list of tables, on which the bean should have it's focus.
99        If empty, all tables are rejected.
100    */
101    [optional, property] sequence<string> TableFilter;
102
103    /** defines a list of table types, on which the bean should have it's focus.
104         If empty, all tables types are rejected.
105     */
106    [optional, property] sequence<string> TableTypeFilter;
107};
108
109//=============================================================================
110
111}; }; }; };
112
113/*===========================================================================
114===========================================================================*/
115#endif
116