offapi/com/sun/star/sdb/XCommandPreparation.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_sdb_XCommandPreparation_idl__
  28 #define __com_sun_star_sdb_XCommandPreparation_idl__
  29
  30 #ifndef __com_sun_star_sdbc_SQLException_idl__
  31 #include <com/sun/star/sdbc/SQLException.idl>
  32 #endif
  33
  34  module com {  module sun {  module star {  module sdbc {
  35  published interface XPreparedStatement;
  36 };};};};
  37
  38  module com {  module sun {  module star {  module sdb {
  39
  40
  41 /** is used for preparation of commands.
  42
  43     <p>
  44     A command could be a table, query, or any kind of SQL statement
  45     prepared by the user.
  46     </p>
  47  */
  48 published interface XCommandPreparation: com::sun::star::uno::XInterface
  49 {
  50
  51     /** creates a
  52         <type scope="com::sun::star::sdbc">PreparedStatement</type>
  53         object for sending parameterized SQL statements to the database.
  54
  55         <p>
  56         A SQL statement with or without IN parameters can be
  57         pre-compiled and stored in a PreparedStatement object. This
  58         object can then be used to efficiently execute this statement
  59         multiple times.
  60         </p>
  61         @param command
  62             the command to be prepared. Any SQL statement.
  63         @param commandType
  64             kind of the command
  65             <type scope="com::sun::star::sdb">CommandType</type>
  66         @returns
  67             the PreparedStatement object
  68         @throws com::sun::star::sdbc::SQLException
  69             if a database access error occurs.
  70      */
  71     com::sun::star::sdbc::XPreparedStatement prepareCommand([in]string command, [in] long commandType)
  72          raises (com::sun::star::sdbc::SQLException);
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 /*===========================================================================
  80 ===========================================================================*/
  81 #endif