xref: /AOO41X/main/offapi/com/sun/star/sdb/XCommandPreparation.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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_sdb_XCommandPreparation_idl__
24#define __com_sun_star_sdb_XCommandPreparation_idl__
25
26#ifndef __com_sun_star_sdbc_SQLException_idl__
27#include <com/sun/star/sdbc/SQLException.idl>
28#endif
29
30 module com {  module sun {  module star {  module sdbc {
31 published interface XPreparedStatement;
32};};};};
33
34 module com {  module sun {  module star {  module sdb {
35
36
37/** is used for preparation of commands.
38
39    <p>
40    A command could be a table, query, or any kind of SQL statement
41    prepared by the user.
42    </p>
43 */
44published interface XCommandPreparation: com::sun::star::uno::XInterface
45{
46
47    /** creates a
48        <type scope="com::sun::star::sdbc">PreparedStatement</type>
49        object for sending parameterized SQL statements to the database.
50
51        <p>
52        A SQL statement with or without IN parameters can be
53        pre-compiled and stored in a PreparedStatement object. This
54        object can then be used to efficiently execute this statement
55        multiple times.
56        </p>
57        @param command
58            the command to be prepared. Any SQL statement.
59        @param commandType
60            kind of the command
61            <type scope="com::sun::star::sdb">CommandType</type>
62        @returns
63            the PreparedStatement object
64        @throws com::sun::star::sdbc::SQLException
65            if a database access error occurs.
66     */
67    com::sun::star::sdbc::XPreparedStatement prepareCommand([in]string command, [in] long commandType)
68        raises (com::sun::star::sdbc::SQLException);
69};
70
71//=============================================================================
72
73}; }; }; };
74
75/*===========================================================================
76===========================================================================*/
77#endif
78