offapi/com/sun/star/sdbc/XResultSetMetaDataSupplier.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_sdbc_XResultSetMetaDataSupplier_idl__
  28 #define __com_sun_star_sdbc_XResultSetMetaDataSupplier_idl__
  29
  30 #ifndef __com_sun_star_uno_XInterface_idl__
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_sdbc_SQLException_idl__
  35 #include <com/sun/star/sdbc/SQLException.idl>
  36 #endif
  37
  38  module com {  module sun {  module star {  module sdbc {
  39
  40  published interface XResultSetMetaData;
  41
  42
  43 /** provides access to the meta data of a result set.
  44
  45
  46     <p>
  47     The number, types, and properties of a ResultSet's columns are
  48     provided by the
  49     <type scope="com::sun::star::sdbc">XResultSetMetaData</type>
  50     interface returned by the
  51     <member scope="com::sun::star::sdbc">XResultSetMetaDataSupplier::getMetaData()</member>
  52     method.
  53     </p>
  54  */
  55 published interface XResultSetMetaDataSupplier: com::sun::star::uno::XInterface
  56 {
  57
  58     /** retrieves the number, types, and properties of a ResultSet's columns.
  59         @returns
  60             the meta data of the ResultSet.
  61         @throws SQLException
  62             if a database access error occurs.
  63      */
  64     XResultSetMetaData getMetaData() raises (SQLException);
  65 };
  66
  67 //=============================================================================
  68
  69 }; }; }; };
  70
  71 /*===========================================================================
  72 ===========================================================================*/
  73 #endif