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