summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sdbcx/XDataDefinitionSupplier.idl
blob: 3a1ad1010d99a99eba2470b499eb25c7d63f9165 (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
/*************************************************************************
 *
 * 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_sdbcx_XDataDefinitionSupplier_idl__
#define __com_sun_star_sdbcx_XDataDefinitionSupplier_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

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

#ifndef __com_sun_star_sdbc_SQLException_idl__
#include <com/sun/star/sdbc/SQLException.idl>
#endif

 module com {  module sun {  module star {  module sdbc {
 published interface XConnection;
};};};};

 module com {  module sun {  module star {  module sdbcx {

 published interface XTablesSupplier;


/** provides the access to data definition beans from a connected database.
 */
published interface XDataDefinitionSupplier: com::sun::star::uno::XInterface
{

    /** returns at least the container of tables related to the given connection.
        @param connection
            the related connection
        @returns
            the container
        @throws com::sun::star::sdbc::SQLException
            if a database access error occurs.
     */
    XTablesSupplier getDataDefinitionByConnection(
                [in]com::sun::star::sdbc::XConnection connection)
        raises (com::sun::star::sdbc::SQLException);
    //-------------------------------------------------------------------------

    /** returns at least the container of tables related to the given Database URL.
        @param url
            a database url of the form  sdbc:subprotocol:subname
        @param info
            a list of arbitrary string tag/value pairs as connection arguments;
            normally at least a "user" and "password" property should be included
        @returns
            the container
        @throws com::sun::star::sdbc::SQLException
            if a database access error occurs.
     */
    XTablesSupplier getDataDefinitionByURL(
                [in]string url,
                [in]sequence<com::sun::star::beans::PropertyValue> info)
        raises (com::sun::star::sdbc::SQLException);
};

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

}; }; }; };

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