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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_sdbc_BatchUpdateException_idl__
  29 #define __com_sun_star_sdbc_BatchUpdateException_idl__
  30
  31 #include <com/sun/star/sdbc/SQLException.idl>
  32
  33  module com {  module sun {  module star {  module sdbc {
  34
  35
  36 /** is thrown when an error occurs during a batch update operation.
  37
  38
  39     <p>In addition to the information provided by
  40     <type scope="com::sun::star::sdbc">SQLException</type>
  41     , a
  42     <code>BatchUpdateException</code>
  43     provides the update counts for all commands
  44     that were executed successfully during the batch update, that is, all commands
  45     that were executed before the error occurred. The order of elements in an
  46     array of update counts corresponds to the order in which commands were added
  47     to the batch.</p>
  48  */
  49 published exception BatchUpdateException: SQLException
  50 {
  51
  52     /** is an array of
  53         <code>long</code>
  54         , with each element
  55         indicating the update count for a SQL command that executed
  56         successfully before the exception was thrown.
  57      */
  58     sequence<long> UpdateCounts;
  59 };
  60
  61 //=============================================================================
  62
  63 }; }; }; };
  64
  65 /*===========================================================================
  66 ===========================================================================*/
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */