offapi/com/sun/star/sdbc/XPreparedStatement.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XPreparedStatement.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sdbc_XPreparedStatement_idl__
  31 #define __com_sun_star_sdbc_XPreparedStatement_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_sdbc_SQLException_idl__
  38 #include <com/sun/star/sdbc/SQLException.idl>
  39 #endif
  40
  41  module com {  module sun {  module star {  module sdbc {
  42
  43  published interface XConnection;
  44  published interface XResultSet;
  45
  46
  47 /** provides the possibilty of executing a precompiled SQL statement.
  48
  49
  50     <p>
  51     A SQL statement is pre-compiled and stored in a PreparedStatement object.
  52     This object can then be used to efficiently execute this statement multiple
  53     times.
  54     </p>
  55  */
  56 published interface XPreparedStatement: com::sun::star::uno::XInterface
  57 {
  58
  59     /** executes the SQL query in this
  60         <code>PreparedStatement</code>
  61         object and returns the result set generated by the query.
  62         @returns
  63             the ResultSet object
  64         @throws SQLException
  65             if a database access error occurs.
  66      */
  67     XResultSet executeQuery() raises (SQLException);
  68     //-------------------------------------------------------------------------
  69
  70     /** executes the SQL INSERT, UPDATE or DELETE statement in this
  71         <type scope="com::sun::star::sdbc">PreparedStatement</type>
  72         object.
  73         <br/>
  74         In addition, SQL statements that return nothing, such as
  75         SQL DDL statements, can be executed.
  76         @returns
  77             either the row count for INSERT, UPDATE or DELETE statements; or 0 for SQL statements that return nothing
  78         @throws SQLException
  79             if a database access error occurs.
  80      */
  81     long executeUpdate() raises (SQLException);
  82     //-------------------------------------------------------------------------
  83
  84     /** executes any kind of SQL statement.
  85
  86
  87         <p>
  88         Some prepared statements return multiple results; the execute
  89         method handles these complex statements as well as the simpler
  90         form of statements handled by executeQuery and executeUpdate.
  91         </p>
  92         @returns
  93             <TRUE/> if successful
  94         @throws SQLException
  95             if a database access error occurs.
  96      */
  97     boolean execute() raises (SQLException);
  98     //-------------------------------------------------------------------------
  99
 100     /** returns the
 101         <type scope="com::sun::star::sdbc">Connection</type>
 102         object
 103         that produced this
 104         <type scope="com::sun::star::sdbc">Statement</type>
 105         object.
 106         @returns
 107             the Connection object
 108         @throws SQLException
 109             if a database access error occurs.
 110      */
 111     XConnection getConnection() raises (SQLException);
 112 };
 113
 114 //=============================================================================
 115
 116 }; }; }; };
 117
 118 /*===========================================================================
 119 ===========================================================================*/
 120 #endif