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