1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_sdbc_XPreparedBatchExecution_idl__
28#define __com_sun_star_sdbc_XPreparedBatchExecution_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_sdbc_SQLException_idl__
35#include <com/sun/star/sdbc/SQLException.idl>
36#endif
37
38 module com {  module sun {  module star {  module sdbc {
39
40
41/** is used for batch execution on PreparedStatements.
42
43
44	<p>
45	A
46	<type scope="com::sun::star::sdbc">PreparedStatement</type>
47	uses one precompiled SQL Statement. In batch execution
48	it is possible to set collection of parameter settings, which are executed in
49	one batch job.
50	</p>
51 */
52published interface XPreparedBatchExecution: com::sun::star::uno::XInterface
53{
54
55	/** adds a set of parameters to the batch.
56		@throws SQLException
57			if a database access error occurs.
58	 */
59	void addBatch() 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
87