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