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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_sdbcx_XDataDefinitionSupplier_idl__
  20 #define __com_sun_star_sdbcx_XDataDefinitionSupplier_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/beans/PropertyValue.idl>
  25
  26 #include <com/sun/star/sdbc/SQLException.idl>
  27
  28  module com {  module sun {  module star {  module sdbc {
  29  published interface XConnection;
  30 };};};};
  31
  32  module com {  module sun {  module star {  module sdbcx {
  33
  34  published interface XTablesSupplier;
  35
  36
  37 /** provides the access to data definition beans from a connected database.
  38  */
  39 published interface XDataDefinitionSupplier: com::sun::star::uno::XInterface
  40 {
  41
  42     /** returns at least the container of tables related to the given connection.
  43         @param connection
  44             the related connection
  45         @returns
  46             the container
  47         @throws com::sun::star::sdbc::SQLException
  48             if a database access error occurs.
  49      */
  50     XTablesSupplier getDataDefinitionByConnection(
  51                 [in]com::sun::star::sdbc::XConnection connection)
  52         raises (com::sun::star::sdbc::SQLException);
  53
  54     /** returns at least the container of tables related to the given Database URL.
  55         @param url
  56             a database url of the form  sdbc:subprotocol:subname
  57         @param info
  58             a list of arbitrary string tag/value pairs as connection arguments;
  59             normally at least a "user" and "password" property should be included
  60         @returns
  61             the container
  62         @throws com::sun::star::sdbc::SQLException
  63             if a database access error occurs.
  64      */
  65     XTablesSupplier getDataDefinitionByURL(
  66                 [in]string url,
  67                 [in]sequence<com::sun::star::beans::PropertyValue> info)
  68         raises (com::sun::star::sdbc::SQLException);
  69 };
  70
  71
  72 }; }; }; };
  73
  74 /*===========================================================================
  75 ===========================================================================*/
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */