offapi/com/sun/star/sdbc/XWarningsSupplier.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_XWarningsSupplier_idl__
  20 #define __com_sun_star_sdbc_XWarningsSupplier_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/sdbc/SQLWarning.idl>
  25
  26  module com {  module sun {  module star {  module sdbc {
  27
  28
  29 /** should be implemented of objects which may report warnings or non critical
  30     errors.
  31     @see com::sun::star::sdbc::SQLWarning
  32  */
  33 published interface XWarningsSupplier: com::sun::star::uno::XInterface
  34 {
  35
  36     /** returns the first warning reported by calls on an object that supports
  37         the usage of warnings.
  38
  39         <p>
  40         <b>Note:</b> Subsequent warnings will be chained to this
  41         com::sun::star::sdbc::SQLWarning.
  42         </p>
  43         @returns
  44             the warnings
  45         @throws SQLException
  46                 if a database access error occurs.
  47      */
  48     any getWarnings() raises (SQLException);
  49
  50
  51     /** clears all warnings reported for the object implementing the interface.
  52         After a call to this method, the method
  53         com::sun::star::sdbc::XWarningsSupplier::getWarnings()
  54         returns
  55         `VOID`
  56         until a new warning is reported for the object.
  57         @throws SQLException
  58                 if a database access error occurs.
  59      */
  60     void clearWarnings() raises (SQLException);
  61 };
  62
  63
  64 }; }; }; };
  65
  66 /*===========================================================================
  67 ===========================================================================*/
  68 #endif
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */