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

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