summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdb/DatabaseAccess.idl
blob: 8eb187384f35d450ecdc783db2aa71ee7e9050a1 (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_sdb_DatabaseAccess_idl__
#define __com_sun_star_sdb_DatabaseAccess_idl__

#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_XNumberFormatsSupplier_idl__
#include <com/sun/star/util/XNumberFormatsSupplier.idl>
#endif


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

 published interface XDatabaseAccess;
 published interface XCompletedConnection;


/** specifies a component, which controls DatabaseAccessConnections and acts like a
    shared DataSource.

    @deprecated
 */
published service DatabaseAccess
{
    // gives access to the properties.
    interface com::sun::star::beans::XPropertySet;

    /** controls the establishing of the connections.
     */
    interface XDatabaseAccess;

    /** establishing a connection with user interaction, the implementation
             is optional.
     */
    [optional] interface XCompletedConnection;

    /** is the URL of the bean.
     */
    [readonly, property] string URL;

    /** is the title of the bean.
     */
    [property] string Title;

    /** 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 ConnectURL;

    /** 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> ConnectInfo;

    /** determines whether modifications on the data access bean are allowed
        or not.
     */
    [readonly, property] boolean IsReadOnly;

    /** provides an object for formatting numbers.
     */
    [property] com::sun::star::util::XNumberFormatsSupplier
                        NumberFormatsSupplier;

    /** indicates that a password is always necessary.
     */
    [optional, property] boolean IsPasswordRequired;

    /** defines a list of tables, on which the bean should have it's focus.
        If empty, all tables are rejected.
    */
    [optional, property] sequence<string> TableFilter;

    /** defines a list of table types, on which the bean should have it's focus.
         If empty, all tables types are rejected.
     */
    [optional, property] sequence<string> TableTypeFilter;
};

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

}; }; }; };

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