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_sdbc_XPreparedStatement_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_sdbc_XPreparedStatement_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdbc_SQLException_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/sdbc/SQLException.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski module com { module sun { module star { module sdbc { 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski published interface XConnection; 37*b1cdbd2cSJim Jagielski published interface XResultSet; 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski 40*b1cdbd2cSJim Jagielski/** provides the possibilty of executing a precompiled SQL statement. 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski <p> 44*b1cdbd2cSJim Jagielski A SQL statement is pre-compiled and stored in a PreparedStatement object. 45*b1cdbd2cSJim Jagielski This object can then be used to efficiently execute this statement multiple 46*b1cdbd2cSJim Jagielski times. 47*b1cdbd2cSJim Jagielski </p> 48*b1cdbd2cSJim Jagielski */ 49*b1cdbd2cSJim Jagielskipublished interface XPreparedStatement: com::sun::star::uno::XInterface 50*b1cdbd2cSJim Jagielski{ 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski /** executes the SQL query in this 53*b1cdbd2cSJim Jagielski <code>PreparedStatement</code> 54*b1cdbd2cSJim Jagielski object and returns the result set generated by the query. 55*b1cdbd2cSJim Jagielski @returns 56*b1cdbd2cSJim Jagielski the ResultSet object 57*b1cdbd2cSJim Jagielski @throws SQLException 58*b1cdbd2cSJim Jagielski if a database access error occurs. 59*b1cdbd2cSJim Jagielski */ 60*b1cdbd2cSJim Jagielski XResultSet executeQuery() raises (SQLException); 61*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski /** executes the SQL INSERT, UPDATE or DELETE statement in this 64*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">PreparedStatement</type> 65*b1cdbd2cSJim Jagielski object. 66*b1cdbd2cSJim Jagielski <br/> 67*b1cdbd2cSJim Jagielski In addition, SQL statements that return nothing, such as 68*b1cdbd2cSJim Jagielski SQL DDL statements, can be executed. 69*b1cdbd2cSJim Jagielski @returns 70*b1cdbd2cSJim Jagielski either the row count for INSERT, UPDATE or DELETE statements; or 0 for SQL statements that return nothing 71*b1cdbd2cSJim Jagielski @throws SQLException 72*b1cdbd2cSJim Jagielski if a database access error occurs. 73*b1cdbd2cSJim Jagielski */ 74*b1cdbd2cSJim Jagielski long executeUpdate() raises (SQLException); 75*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski /** executes any kind of SQL statement. 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski <p> 81*b1cdbd2cSJim Jagielski Some prepared statements return multiple results; the execute 82*b1cdbd2cSJim Jagielski method handles these complex statements as well as the simpler 83*b1cdbd2cSJim Jagielski form of statements handled by executeQuery and executeUpdate. 84*b1cdbd2cSJim Jagielski </p> 85*b1cdbd2cSJim Jagielski @returns 86*b1cdbd2cSJim Jagielski <TRUE/> if successful 87*b1cdbd2cSJim Jagielski @throws SQLException 88*b1cdbd2cSJim Jagielski if a database access error occurs. 89*b1cdbd2cSJim Jagielski */ 90*b1cdbd2cSJim Jagielski boolean execute() raises (SQLException); 91*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski /** returns the 94*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">Connection</type> 95*b1cdbd2cSJim Jagielski object 96*b1cdbd2cSJim Jagielski that produced this 97*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">Statement</type> 98*b1cdbd2cSJim Jagielski object. 99*b1cdbd2cSJim Jagielski @returns 100*b1cdbd2cSJim Jagielski the Connection object 101*b1cdbd2cSJim Jagielski @throws SQLException 102*b1cdbd2cSJim Jagielski if a database access error occurs. 103*b1cdbd2cSJim Jagielski */ 104*b1cdbd2cSJim Jagielski XConnection getConnection() raises (SQLException); 105*b1cdbd2cSJim Jagielski}; 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski//============================================================================= 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski}; }; }; }; 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski/*=========================================================================== 112*b1cdbd2cSJim Jagielski===========================================================================*/ 113*b1cdbd2cSJim Jagielski#endif 114