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