offapi/com/sun/star/sdbc/XResultSetMetaDataSupplier.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_sdbc_XResultSetMetaDataSupplier_idl__
  20 #define __com_sun_star_sdbc_XResultSetMetaDataSupplier_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/sdbc/SQLException.idl>
  25
  26  module com {  module sun {  module star {  module sdbc {
  27
  28  published interface XResultSetMetaData;
  29
  30
  31 /** provides access to the meta data of a result set.
  32
  33
  34     <p>
  35     The number, types, and properties of a ResultSet's columns are
  36     provided by the
  37     com::sun::star::sdbc::XResultSetMetaData
  38     interface returned by the
  39     com::sun::star::sdbc::XResultSetMetaDataSupplier::getMetaData()
  40     method.
  41     </p>
  42  */
  43 published interface XResultSetMetaDataSupplier: com::sun::star::uno::XInterface
  44 {
  45
  46     /** retrieves the number, types, and properties of a ResultSet's columns.
  47         @returns
  48             the meta data of the ResultSet.
  49         @throws SQLException
  50             if a database access error occurs.
  51      */
  52     XResultSetMetaData getMetaData() raises (SQLException);
  53 };
  54
  55
  56 }; }; }; };
  57
  58 /*===========================================================================
  59 ===========================================================================*/
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */