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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XWarningsSupplier.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdbc_XWarningsSupplier_idl__
  31 #define __com_sun_star_sdbc_XWarningsSupplier_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_sdbc_SQLWarning_idl__
  38 #include <com/sun/star/sdbc/SQLWarning.idl>
  39 #endif
  40
  41  module com {  module sun {  module star {  module sdbc {
  42
  43
  44 /** should be implemented of objects which may report warnings or non critical
  45     errors.
  46     @see com::sun::star::sdbc::SQLWarning
  47  */
  48 published interface XWarningsSupplier: com::sun::star::uno::XInterface
  49 {
  50     //-------------------------------------------------------------------------
  51
  52     /** returns the first warning reported by calls on an object that supports
  53         the usage of warnings.
  54
  55         <p>
  56         <b>Note:</b> Subsequent warnings will be chained to this
  57         <type scope="com::sun::star::sdbc">SQLWarning</type>
  58         .
  59         </p>
  60         @returns
  61             the warnings
  62         @throws SQLException
  63                 if a database access error occurs.
  64      */
  65     any getWarnings() raises (SQLException);
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** clears all warnings reported for the object implementing the interface.
  70         After a call to this method, the method
  71         <member scope="com::sun::star::sdbc">XWarningsSupplier::getWarnings()</member>
  72         returns
  73         <void/>
  74         until a new warning is reported for the object.
  75         @throws SQLException
  76                 if a database access error occurs.
  77      */
  78     void clearWarnings() raises (SQLException);
  79 };
  80
  81 //=============================================================================
  82
  83 }; }; }; };
  84
  85 /*===========================================================================
  86 ===========================================================================*/
  87 #endif