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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDataDefinitionSupplier.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdbcx_XDataDefinitionSupplier_idl__
  31 #define __com_sun_star_sdbcx_XDataDefinitionSupplier_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_PropertyValue_idl__
  38 #include <com/sun/star/beans/PropertyValue.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_sdbc_SQLException_idl__
  42 #include <com/sun/star/sdbc/SQLException.idl>
  43 #endif
  44
  45  module com {  module sun {  module star {  module sdbc {
  46  published interface XConnection;
  47 };};};};
  48
  49  module com {  module sun {  module star {  module sdbcx {
  50
  51  published interface XTablesSupplier;
  52
  53
  54 /** provides the access to data definition beans from a connected database.
  55  */
  56 published interface XDataDefinitionSupplier: com::sun::star::uno::XInterface
  57 {
  58
  59     /** returns at least the container of tables related to the given connection.
  60         @param connection
  61             the related connection
  62         @returns
  63             the container
  64         @throws com::sun::star::sdbc::SQLException
  65             if a database access error occurs.
  66      */
  67     XTablesSupplier getDataDefinitionByConnection(
  68                 [in]com::sun::star::sdbc::XConnection connection)
  69         raises (com::sun::star::sdbc::SQLException);
  70     //-------------------------------------------------------------------------
  71
  72     /** returns at least the container of tables related to the given Database URL.
  73         @param url
  74             a database url of the form  sdbc:subprotocol:subname
  75         @param info
  76             a list of arbitrary string tag/value pairs as connection arguments;
  77             normally at least a "user" and "password" property should be included
  78         @returns
  79             the container
  80         @throws com::sun::star::sdbc::SQLException
  81             if a database access error occurs.
  82      */
  83     XTablesSupplier getDataDefinitionByURL(
  84                 [in]string url,
  85                 [in]sequence<com::sun::star::beans::PropertyValue> info)
  86         raises (com::sun::star::sdbc::SQLException);
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 /*===========================================================================
  94 ===========================================================================*/
  95 #endif