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