summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sdb/DatabaseAccess.idl
blob: 22ab69c96a211bec27d5cdfc83c4ccbeea410c23 (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
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_sdb_DatabaseAccess_idl__
#define __com_sun_star_sdb_DatabaseAccess_idl__

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

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

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


 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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */