offapi/com/sun/star/sdbc/XBatchExecution.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: XBatchExecution.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_XBatchExecution_idl__
  31 #define __com_sun_star_sdbc_XBatchExecution_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  published interface XResultSet;
  44
  45
  46 /** is used for collecting and executing a set of SQL statements.
  47  */
  48 published interface XBatchExecution: com::sun::star::uno::XInterface
  49 {
  50
  51     /** adds a SQL command to the current batch of commmands for the statement
  52         object.
  53         @param sql
  54             the SQL statement which should be appended to the batch.
  55
  56         @throws SQLException
  57             if a database access error occurs.
  58      */
  59     void addBatch([in]string sql ) raises (SQLException);
  60     //-------------------------------------------------------------------------
  61
  62     /** makes the set of commands in the current batch empty.
  63         @throws SQLException
  64             if a database access error occurs.
  65      */
  66     void clearBatch() raises (SQLException);
  67     //-------------------------------------------------------------------------
  68
  69     /** submits a batch of commands to the database for execution.
  70              @returns
  71                 an array of update counts containing one element for each
  72                  command in the batch. The array is ordered according to the order in
  73                 which commands were inserted into the batch.
  74              @throws SQLException
  75                 if a database access error occurs.
  76      */
  77     sequence<long> executeBatch() raises (SQLException);
  78 };
  79
  80 //=============================================================================
  81
  82 }; }; }; };
  83
  84 /*===========================================================================
  85 ===========================================================================*/
  86 #endif