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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_sdbc_XBatchExecution_idl__
  20 #define __com_sun_star_sdbc_XBatchExecution_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/sdbc/SQLException.idl>
  25
  26  module com {  module sun {  module star {  module sdbc {
  27
  28  published interface XResultSet;
  29
  30
  31 /** is used for collecting and executing a set of SQL statements.
  32  */
  33 published interface XBatchExecution: com::sun::star::uno::XInterface
  34 {
  35
  36     /** adds a SQL command to the current batch of commands for the statement
  37         object.
  38         @param sql
  39             the SQL statement which should be appended to the batch.
  40
  41         @throws SQLException
  42             if a database access error occurs.
  43      */
  44     void addBatch([in]string sql ) raises (SQLException);
  45
  46     /** makes the set of commands in the current batch empty.
  47         @throws SQLException
  48             if a database access error occurs.
  49      */
  50     void clearBatch() raises (SQLException);
  51
  52     /** submits a batch of commands to the database for execution.
  53              @returns
  54                 an array of update counts containing one element for each
  55                  command in the batch. The array is ordered according to the order in
  56                 which commands were inserted into the batch.
  57              @throws SQLException
  58                 if a database access error occurs.
  59      */
  60     sequence<long> executeBatch() raises (SQLException);
  61 };
  62
  63
  64 }; }; }; };
  65
  66 /*===========================================================================
  67 ===========================================================================*/
  68 #endif
  69
  70 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */