offapi/com/sun/star/sdbcx/XDataDefinitionSupplier.idl

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