offapi/com/sun/star/sdbc/XPreparedBatchExecution.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: XPreparedBatchExecution.idl,v $
  10  * $Revision: 1.10 $
  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_XPreparedBatchExecution_idl__
  31 #define __com_sun_star_sdbc_XPreparedBatchExecution_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_sdbc_SQLException_idl__
  38 #include <com/sun/star/sdbc/SQLException.idl>
  39 #endif
  40
  41  module com {  module sun {  module star {  module sdbc {
  42
  43
  44 /** is used for batch execution on PreparedStatements.
  45
  46
  47     <p>
  48     A
  49     <type scope="com::sun::star::sdbc">PreparedStatement</type>
  50     uses one precompiled SQL Statement. In batch execution
  51     it is possible to set collection of parameter settings, which are executed in
  52     one batch job.
  53     </p>
  54  */
  55 published interface XPreparedBatchExecution: com::sun::star::uno::XInterface
  56 {
  57
  58     /** adds a set of parameters to the batch.
  59         @throws SQLException
  60             if a database access error occurs.
  61      */
  62     void addBatch() raises (SQLException);
  63     //-------------------------------------------------------------------------
  64
  65     /** makes the set of commands in the current batch empty.
  66         @throws SQLException
  67             if a database access error occurs.
  68      */
  69     void clearBatch() raises (SQLException);
  70     //-------------------------------------------------------------------------
  71
  72     /** submits a batch of commands to the database for execution.
  73              @returns
  74                 an array of update counts containing one element for each
  75                  command in the batch. The array is ordered according to the order in
  76                 which commands were inserted into the batch.
  77              @throws SQLException
  78                 if a database access error occurs.
  79      */
  80     sequence<long> executeBatch() raises (SQLException);
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 /*===========================================================================
  88 ===========================================================================*/
  89 #endif