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
  20  module com {  module sun {  module star {  module sdbc {
  21  published interface XConnection;
  22 };};};};
  23
  24  module com {  module sun {  module star {  module sdbcx {
  25
  26  published interface XTablesSupplier;
  27
  28
  29 /** provides the access to data definition beans from a connected database.
  30  */
  31 published interface XDataDefinitionSupplier: com::sun::star::uno::XInterface
  32 {
  33
  34     /** returns at least the container of tables related to the given connection.
  35         @param connection
  36             the related connection
  37         @returns
  38             the container
  39         @throws com::sun::star::sdbc::SQLException
  40             if a database access error occurs.
  41      */
  42     XTablesSupplier getDataDefinitionByConnection(
  43                 [in]com::sun::star::sdbc::XConnection connection)
  44         raises (com::sun::star::sdbc::SQLException);
  45
  46     /** returns at least the container of tables related to the given Database URL.
  47         @param url
  48             a database url of the form  sdbc:subprotocol:subname
  49         @param info
  50             a list of arbitrary string tag/value pairs as connection arguments;
  51             normally at least a "user" and "password" property should be included
  52         @returns
  53             the container
  54         @throws com::sun::star::sdbc::SQLException
  55             if a database access error occurs.
  56      */
  57     XTablesSupplier getDataDefinitionByURL(
  58                 [in]string url,
  59                 [in]sequence<com::sun::star::beans::PropertyValue> info)
  60         raises (com::sun::star::sdbc::SQLException);
  61 };
  62
  63
  64 }; }; }; };
  65
  66 /*===========================================================================
  67 ===========================================================================*/
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */