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