1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdbc_XMultipleResults_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_sdbc_XMultipleResults_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_uno_XInterface_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/uno/XInterface.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_sdbc_SQLException_idl__ 31*b1cdbd2cSJim Jagielski#include <com/sun/star/sdbc/SQLException.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski module com { module sun { module star { module sdbc { 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski published interface XResultSet; 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski/** is used for inspecting multiple results produced by the execution of a 40*b1cdbd2cSJim Jagielski SQL statement. 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski <p> 44*b1cdbd2cSJim Jagielski Under some (uncommon) situations a single SQL statement may return 45*b1cdbd2cSJim Jagielski multiple result sets and/or update counts. Normally you can ignore 46*b1cdbd2cSJim Jagielski this unless you are (1) executing a stored procedure that you know may 47*b1cdbd2cSJim Jagielski return multiple results or (2) you are dynamically executing an 48*b1cdbd2cSJim Jagielski unknown SQL string. The methods 49*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XMultipleResults::getMoreResults()</member> 50*b1cdbd2cSJim Jagielski , 51*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XMultipleResults::getResultSet()</member> 52*b1cdbd2cSJim Jagielski and 53*b1cdbd2cSJim Jagielski <member scope="com::sun::star::sdbc">XMultipleResults::getUpdateCount()</member> 54*b1cdbd2cSJim Jagielski let you navigate through multiple results. 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski </p> 57*b1cdbd2cSJim Jagielski @see com::sun::star::sdbc::XStatement 58*b1cdbd2cSJim Jagielski @see com::sun::star::sdbc::XPreparedStatement 59*b1cdbd2cSJim Jagielski */ 60*b1cdbd2cSJim Jagielskipublished interface XMultipleResults: com::sun::star::uno::XInterface 61*b1cdbd2cSJim Jagielski{ 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski /** returns the current result as a 64*b1cdbd2cSJim Jagielski <type scope="com::sun::star::sdbc">ResultSet</type> 65*b1cdbd2cSJim Jagielski object. 66*b1cdbd2cSJim Jagielski This method should be called only once per result. 67*b1cdbd2cSJim Jagielski @returns 68*b1cdbd2cSJim Jagielski the ResultSet object 69*b1cdbd2cSJim Jagielski @throws SQLException 70*b1cdbd2cSJim Jagielski if a database access error occurs. 71*b1cdbd2cSJim Jagielski */ 72*b1cdbd2cSJim Jagielski XResultSet getResultSet() raises (SQLException); 73*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski /** returns the current result as an update count. 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski <p> 79*b1cdbd2cSJim Jagielski If the result is a ResultSet or there are no more results, -1 80*b1cdbd2cSJim Jagielski is returned. This method should be called only once per result. 81*b1cdbd2cSJim Jagielski </p> 82*b1cdbd2cSJim Jagielski @returns 83*b1cdbd2cSJim Jagielski the current result as an update count. 84*b1cdbd2cSJim Jagielski @throws SQLException 85*b1cdbd2cSJim Jagielski if a database access error occurs. 86*b1cdbd2cSJim Jagielski */ 87*b1cdbd2cSJim Jagielski long getUpdateCount() raises (SQLException); 88*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski /** moves to a Statement's next result. It returns <TRUE/> if 91*b1cdbd2cSJim Jagielski this result is a ResultSet. This method also implicitly 92*b1cdbd2cSJim Jagielski closes any current ResultSet obtained with getResultSet. 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski <p> 95*b1cdbd2cSJim Jagielski There are no more results when <code>(!getMoreResults() &amp;&amp; 96*b1cdbd2cSJim Jagielski getUpdateCount() == -1)</code>. 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski </p> 99*b1cdbd2cSJim Jagielski @returns 100*b1cdbd2cSJim Jagielski <TRUE/> if there exists more ResultSet objects 101*b1cdbd2cSJim Jagielski @throws SQLException 102*b1cdbd2cSJim Jagielski if a database access error occurs. 103*b1cdbd2cSJim Jagielski */ 104*b1cdbd2cSJim Jagielski boolean getMoreResults() raises (SQLException); 105*b1cdbd2cSJim Jagielski}; 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski//============================================================================= 108*b1cdbd2cSJim Jagielski 109*b1cdbd2cSJim Jagielski}; }; }; }; 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski/*=========================================================================== 112*b1cdbd2cSJim Jagielski===========================================================================*/ 113*b1cdbd2cSJim Jagielski#endif 114