offapi/com/sun/star/sdbc/XMultipleResults.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 #ifndef __com_sun_star_sdbc_XMultipleResults_idl__
  20 #define __com_sun_star_sdbc_XMultipleResults_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/sdbc/SQLException.idl>
  25
  26  module com {  module sun {  module star {  module sdbc {
  27
  28  published interface XResultSet;
  29
  30
  31 /** is used for inspecting multiple results produced by the execution of a
  32     SQL statement.
  33
  34
  35     <p>
  36     Under some (uncommon) situations a single SQL statement may return
  37     multiple result sets and/or update counts.  Normally you can ignore
  38     this unless you are (1) executing a stored procedure that you know may
  39     return multiple results or (2) you are dynamically executing an
  40     unknown SQL string. The methods
  41     com::sun::star::sdbc::XMultipleResults::getMoreResults()
  42     ,
  43     com::sun::star::sdbc::XMultipleResults::getResultSet()
  44     and
  45     com::sun::star::sdbc::XMultipleResults::getUpdateCount()
  46     let you navigate through multiple results.
  47
  48     </p>
  49     @see com::sun::star::sdbc::XStatement
  50      @see com::sun::star::sdbc::XPreparedStatement
  51  */
  52 published interface XMultipleResults: com::sun::star::uno::XInterface
  53 {
  54
  55     /** returns the current result as a
  56         com::sun::star::sdbc::ResultSet
  57         object.
  58         This method should be called only once per result.
  59         @returns
  60             the ResultSet object
  61         @throws SQLException
  62             if a database access error occurs.
  63      */
  64     XResultSet getResultSet() raises (SQLException);
  65
  66     /** returns the current result as an update count.
  67
  68
  69         <p>
  70         If the result is a ResultSet or there are no more results, -1
  71         is returned. This method should be called only once per result.
  72         </p>
  73         @returns
  74             the current result as an update count.
  75         @throws SQLException
  76             if a database access error occurs.
  77      */
  78     long getUpdateCount() raises (SQLException);
  79
  80     /** moves to a Statement's next result. It returns `TRUE` if
  81         this result is a ResultSet.  This method also implicitly
  82         closes any current ResultSet obtained with getResultSet.
  83
  84         <p>
  85         There are no more results when <code>(!getMoreResults() &amp;amp;&amp;amp;
  86         getUpdateCount() == -1)</code>.
  87
  88         </p>
  89         @returns
  90             `TRUE` if there exists more ResultSet objects
  91         @throws SQLException
  92             if a database access error occurs.
  93      */
  94     boolean getMoreResults() raises (SQLException);
  95 };
  96
  97
  98 }; }; }; };
  99
 100 /*===========================================================================
 101 ===========================================================================*/
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */