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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20  module com {  module sun {  module star {  module sdbc {
  21  published interface XPreparedStatement;
  22 };};};};
  23
  24  module com {  module sun {  module star {  module sdb {
  25
  26
  27 /** is used for preparation of commands.
  28
  29     <p>
  30     A command could be a table, query, or any kind of SQL statement
  31     prepared by the user.
  32     </p>
  33  */
  34 published interface XCommandPreparation: com::sun::star::uno::XInterface
  35 {
  36
  37     /** creates a
  38         com::sun::star::sdbc::PreparedStatement
  39         object for sending parameterized SQL statements to the database.
  40
  41         <p>
  42         A SQL statement with or without IN parameters can be
  43         pre-compiled and stored in a PreparedStatement object. This
  44         object can then be used to efficiently execute this statement
  45         multiple times.
  46         </p>
  47         @param command
  48             the command to be prepared. Any SQL statement.
  49         @param commandType
  50             kind of the command
  51             com::sun::star::sdb::CommandType
  52         @returns
  53             the PreparedStatement object
  54         @throws com::sun::star::sdbc::SQLException
  55             if a database access error occurs.
  56      */
  57     com::sun::star::sdbc::XPreparedStatement prepareCommand([in]string command, [in] long commandType)
  58          raises (com::sun::star::sdbc::SQLException);
  59 };
  60
  61
  62 }; }; }; };
  63
  64 /*===========================================================================
  65 ===========================================================================*/
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */