offapi/com/sun/star/sdbc/BatchUpdateException.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_BatchUpdateException_idl__
  20 #define __com_sun_star_sdbc_BatchUpdateException_idl__
  21
  22 #include <com/sun/star/sdbc/SQLException.idl>
  23
  24  module com {  module sun {  module star {  module sdbc {
  25
  26
  27 /** is thrown when an error occurs during a batch update operation.
  28
  29
  30     <p>In addition to the information provided by
  31     com::sun::star::sdbc::SQLException
  32     , a
  33     <code>BatchUpdateException</code>
  34     provides the update counts for all commands
  35     that were executed successfully during the batch update, that is, all commands
  36     that were executed before the error occurred. The order of elements in an
  37     array of update counts corresponds to the order in which commands were added
  38     to the batch.</p>
  39  */
  40 published exception BatchUpdateException: SQLException
  41 {
  42
  43     /** is an array of
  44         <code>long</code>
  45         , with each element
  46         indicating the update count for a SQL command that executed
  47         successfully before the exception was thrown.
  48      */
  49     sequence<long> UpdateCounts;
  50 };
  51
  52
  53 }; }; }; };
  54
  55 /*===========================================================================
  56 ===========================================================================*/
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */