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