xref: /trunk/main/offapi/com/sun/star/sdb/DatabaseAccess.idl (revision fc9fd3f14a55d77b35643a64034752a178b2a5b0)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_sdb_DatabaseAccess_idl__
28#define __com_sun_star_sdb_DatabaseAccess_idl__
29
30#ifndef __com_sun_star_beans_XPropertySet_idl__
31#include <com/sun/star/beans/XPropertySet.idl>
32#endif
33
34#ifndef __com_sun_star_beans_PropertyValue_idl__
35#include <com/sun/star/beans/PropertyValue.idl>
36#endif
37
38#ifndef __com_sun_star_util_XNumberFormatsSupplier_idl__
39#include <com/sun/star/util/XNumberFormatsSupplier.idl>
40#endif
41
42
43 module com {  module sun {  module star {  module sdb {
44
45 published interface XDatabaseAccess;
46 published interface XCompletedConnection;
47
48
49/** specifies a component, which controls DatabaseAccessConnections and acts like a
50    shared DataSource.
51
52    @deprecated
53 */
54published service DatabaseAccess
55{
56    // gives access to the properties.
57    interface com::sun::star::beans::XPropertySet;
58
59    /** controls the establishing of the connections.
60     */
61    interface XDatabaseAccess;
62
63    /** establishing a connection with user interaction, the implementation
64             is optional.
65     */
66    [optional] interface XCompletedConnection;
67
68    /** is the URL of the bean.
69     */
70    [readonly, property] string URL;
71
72    /** is the title of the bean.
73     */
74    [property] string Title;
75
76    /** indicates a database url of the form <br>
77        <code> jdbc:<em>subprotocol</em>:<em>subname</em></code> or
78        <code> sdbc:<em>subprotocol</em>:<em>subname</em></code>
79     */
80    [property] string ConnectURL;
81
82    /** is a list of arbitrary string tag/value pairs as
83             connection arguments; normally at least a "user" and
84             "password" property should be included.
85     */
86    [property] sequence<com::sun::star::beans::PropertyValue> ConnectInfo;
87
88    /** determines whether modifications on the data access bean are allowed
89        or not.
90     */
91    [readonly, property] boolean IsReadOnly;
92
93    /** provides an object for formatting numbers.
94     */
95    [property] com::sun::star::util::XNumberFormatsSupplier
96                        NumberFormatsSupplier;
97
98    /** indicates that a password is always necessary.
99     */
100    [optional, property] boolean IsPasswordRequired;
101
102    /** defines a list of tables, on which the bean should have it's focus.
103        If empty, all tables are rejected.
104    */
105    [optional, property] sequence<string> TableFilter;
106
107    /** defines a list of table types, on which the bean should have it's focus.
108         If empty, all tables types are rejected.
109     */
110    [optional, property] sequence<string> TableTypeFilter;
111};
112
113//=============================================================================
114
115}; }; }; };
116
117/*===========================================================================
118===========================================================================*/
119#endif
120