xref: /trunk/main/offapi/com/sun/star/sdbc/XBatchExecution.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef __com_sun_star_sdbc_XBatchExecution_idl__
24cdf0e10cSrcweir#define __com_sun_star_sdbc_XBatchExecution_idl__
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__
27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#ifndef __com_sun_star_sdbc_SQLException_idl__
31cdf0e10cSrcweir#include <com/sun/star/sdbc/SQLException.idl>
32cdf0e10cSrcweir#endif
33cdf0e10cSrcweir
34cdf0e10cSrcweir module com {  module sun {  module star {  module sdbc {
35cdf0e10cSrcweir
36cdf0e10cSrcweir published interface XResultSet;
37cdf0e10cSrcweir
38cdf0e10cSrcweir
39cdf0e10cSrcweir/** is used for collecting and executing a set of SQL statements.
40cdf0e10cSrcweir */
41cdf0e10cSrcweirpublished interface XBatchExecution: com::sun::star::uno::XInterface
42cdf0e10cSrcweir{
43cdf0e10cSrcweir
44*d4e90fa5SJohn Bampton    /** adds a SQL command to the current batch of commands for the statement
45cdf0e10cSrcweir        object.
46cdf0e10cSrcweir        @param sql
47cdf0e10cSrcweir            the SQL statement which should be appended to the batch.
48cdf0e10cSrcweir
49cdf0e10cSrcweir        @throws SQLException
50cdf0e10cSrcweir            if a database access error occurs.
51cdf0e10cSrcweir     */
52cdf0e10cSrcweir    void addBatch([in]string sql ) raises (SQLException);
53cdf0e10cSrcweir    //-------------------------------------------------------------------------
54cdf0e10cSrcweir
55cdf0e10cSrcweir    /** makes the set of commands in the current batch empty.
56cdf0e10cSrcweir        @throws SQLException
57cdf0e10cSrcweir            if a database access error occurs.
58cdf0e10cSrcweir     */
59cdf0e10cSrcweir    void clearBatch() raises (SQLException);
60cdf0e10cSrcweir    //-------------------------------------------------------------------------
61cdf0e10cSrcweir
62cdf0e10cSrcweir    /** submits a batch of commands to the database for execution.
63cdf0e10cSrcweir             @returns
64cdf0e10cSrcweir                an array of update counts containing one element for each
65cdf0e10cSrcweir                command in the batch. The array is ordered according to the order in
66cdf0e10cSrcweir                which commands were inserted into the batch.
67cdf0e10cSrcweir             @throws SQLException
68cdf0e10cSrcweir                if a database access error occurs.
69cdf0e10cSrcweir     */
70cdf0e10cSrcweir    sequence<long> executeBatch() raises (SQLException);
71cdf0e10cSrcweir};
72cdf0e10cSrcweir
73cdf0e10cSrcweir//=============================================================================
74cdf0e10cSrcweir
75cdf0e10cSrcweir}; }; }; };
76cdf0e10cSrcweir
77cdf0e10cSrcweir/*===========================================================================
78cdf0e10cSrcweir===========================================================================*/
79cdf0e10cSrcweir#endif
80