xref: /AOO41X/main/offapi/com/sun/star/sdbcx/XDataDefinitionSupplier.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_sdbcx_XDataDefinitionSupplier_idl__
24#define __com_sun_star_sdbcx_XDataDefinitionSupplier_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.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_sdbc_SQLException_idl__
35#include <com/sun/star/sdbc/SQLException.idl>
36#endif
37
38 module com {  module sun {  module star {  module sdbc {
39 published interface XConnection;
40};};};};
41
42 module com {  module sun {  module star {  module sdbcx {
43
44 published interface XTablesSupplier;
45
46
47/** provides the access to data definition beans from a connected database.
48 */
49published interface XDataDefinitionSupplier: com::sun::star::uno::XInterface
50{
51
52    /** returns at least the container of tables related to the given connection.
53        @param connection
54            the related connection
55        @returns
56            the container
57        @throws com::sun::star::sdbc::SQLException
58            if a database access error occurs.
59     */
60    XTablesSupplier getDataDefinitionByConnection(
61                [in]com::sun::star::sdbc::XConnection connection)
62        raises (com::sun::star::sdbc::SQLException);
63    //-------------------------------------------------------------------------
64
65    /** returns at least the container of tables related to the given Database URL.
66        @param url
67            a database url of the form  sdbc:subprotocol:subname
68        @param info
69            a list of arbitrary string tag/value pairs as connection arguments;
70            normally at least a "user" and "password" property should be included
71        @returns
72            the container
73        @throws com::sun::star::sdbc::SQLException
74            if a database access error occurs.
75     */
76    XTablesSupplier getDataDefinitionByURL(
77                [in]string url,
78                [in]sequence<com::sun::star::beans::PropertyValue> info)
79        raises (com::sun::star::sdbc::SQLException);
80};
81
82//=============================================================================
83
84}; }; }; };
85
86/*===========================================================================
87===========================================================================*/
88#endif
89