1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdb_XCommandPreparation_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_sdb_XCommandPreparation_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdbc_SQLException_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/sdbc/SQLException.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski module com { module sun { module star { module sdbc { 31*b1cdbd2cSJim Jagielski published interface XPreparedStatement; 32*b1cdbd2cSJim Jagielski};};};}; 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski module com { module sun { module star { module sdb { 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski/** is used for preparation of commands. 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski <p> 40*b1cdbd2cSJim Jagielski A command could be a table, query, or any kind of SQL statement 41*b1cdbd2cSJim Jagielski prepared by the user. 42*b1cdbd2cSJim Jagielski </p> 43*b1cdbd2cSJim Jagielski */ 44*b1cdbd2cSJim Jagielskipublished interface XCommandPreparation: com::sun::star::uno::XInterface 45*b1cdbd2cSJim Jagielski{ 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski /** creates a 48*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">PreparedStatement</type> 49*b1cdbd2cSJim Jagielski object for sending parameterized SQL statements to the database. 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski <p> 52*b1cdbd2cSJim Jagielski A SQL statement with or without IN parameters can be 53*b1cdbd2cSJim Jagielski pre-compiled and stored in a PreparedStatement object. This 54*b1cdbd2cSJim Jagielski object can then be used to efficiently execute this statement 55*b1cdbd2cSJim Jagielski multiple times. 56*b1cdbd2cSJim Jagielski </p> 57*b1cdbd2cSJim Jagielski @param command 58*b1cdbd2cSJim Jagielski the command to be prepared. Any SQL statement. 59*b1cdbd2cSJim Jagielski @param commandType 60*b1cdbd2cSJim Jagielski kind of the command 61*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdb">CommandType</type> 62*b1cdbd2cSJim Jagielski @returns 63*b1cdbd2cSJim Jagielski the PreparedStatement object 64*b1cdbd2cSJim Jagielski @throws com::sun::star::sdbc::SQLException 65*b1cdbd2cSJim Jagielski if a database access error occurs. 66*b1cdbd2cSJim Jagielski */ 67*b1cdbd2cSJim Jagielski com::sun::star::sdbc::XPreparedStatement prepareCommand([in]string command, [in] long commandType) 68*b1cdbd2cSJim Jagielski raises (com::sun::star::sdbc::SQLException); 69*b1cdbd2cSJim Jagielski}; 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski//============================================================================= 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski}; }; }; }; 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski/*=========================================================================== 76*b1cdbd2cSJim Jagielski===========================================================================*/ 77*b1cdbd2cSJim Jagielski#endif 78