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