offapi/com/sun/star/sdbc/BatchUpdateException.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: BatchUpdateException.idl,v $
  10  * $Revision: 1.9 $
  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_BatchUpdateException_idl__
  31 #define __com_sun_star_sdbc_BatchUpdateException_idl__
  32
  33 #ifndef __com_sun_star_sdbc_SQLException_idl__
  34 #include <com/sun/star/sdbc/SQLException.idl>
  35 #endif
  36
  37  module com {  module sun {  module star {  module sdbc {
  38
  39
  40 /** is thrown when an error occurs during a batch update operation.
  41
  42
  43     <p>In addition to the information provided by
  44     <type scope="com::sun::star::sdbc">SQLException</type>
  45     , a
  46     <code>BatchUpdateException</code>
  47     provides the update counts for all commands
  48     that were executed successfully during the batch update, that is, all commands
  49     that were executed before the error occurred. The order of elements in an
  50     array of update counts corresponds to the order in which commands were added
  51     to the batch.</p>
  52  */
  53 published exception BatchUpdateException: SQLException
  54 {
  55
  56     /** is an array of
  57         <code>long</code>
  58         , with each element
  59         indicating the update count for a SQL command that executed
  60         successfully before the exception was thrown.
  61      */
  62     sequence<long> UpdateCounts;
  63 };
  64
  65 //=============================================================================
  66
  67 }; }; }; };
  68
  69 /*===========================================================================
  70 ===========================================================================*/
  71 #endif