offapi/com/sun/star/sdbc/XWarningsSupplier.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_XWarningsSupplier_idl__
  28 #define __com_sun_star_sdbc_XWarningsSupplier_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_SQLWarning_idl__
  35 #include <com/sun/star/sdbc/SQLWarning.idl>
  36 #endif
  37
  38  module com {  module sun {  module star {  module sdbc {
  39
  40
  41 /** should be implemented of objects which may report warnings or non critical
  42     errors.
  43     @see com::sun::star::sdbc::SQLWarning
  44  */
  45 published interface XWarningsSupplier: com::sun::star::uno::XInterface
  46 {
  47     //-------------------------------------------------------------------------
  48
  49     /** returns the first warning reported by calls on an object that supports
  50         the usage of warnings.
  51
  52         <p>
  53         <b>Note:</b> Subsequent warnings will be chained to this
  54         <type scope="com::sun::star::sdbc">SQLWarning</type>
  55         .
  56         </p>
  57         @returns
  58             the warnings
  59         @throws SQLException
  60                 if a database access error occurs.
  61      */
  62     any getWarnings() raises (SQLException);
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** clears all warnings reported for the object implementing the interface.
  67         After a call to this method, the method
  68         <member scope="com::sun::star::sdbc">XWarningsSupplier::getWarnings()</member>
  69         returns
  70         <void/>
  71         until a new warning is reported for the object.
  72         @throws SQLException
  73                 if a database access error occurs.
  74      */
  75     void clearWarnings() raises (SQLException);
  76 };
  77
  78 //=============================================================================
  79
  80 }; }; }; };
  81
  82 /*===========================================================================
  83 ===========================================================================*/
  84 #endif