/*************************************************************************
 *
 *  $RCSfile: XMultipleResults.idl,v $
 *
 *  $Revision: 1.5.18.2 $
 *
 *  last change: $Author: mi $ $Date: 2003/01/21 17:46:44 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_sdbc_XMultipleResults_idl__ 
#define __com_sun_star_sdbc_XMultipleResults_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_sdbc_SQLException_idl__ 
#include <com/sun/star/sdbc/SQLException.idl> 
#endif 
 
 module com {  module sun {  module star {  module sdbc { 
 
interface XResultSet; 
 
 
// DocMerge from xml: interface com::sun::star::sdbc::XMultipleResults
/** is used for inspecting multiple results produced by the execution of a
	SQL statement.
	
	
	<p>
	Under some (uncommon) situations a single SQL statement may return
	multiple result sets and/or update counts.  Normally you can ignore
	this unless you are (1) executing a stored procedure that you know may
	return multiple results or (2) you are dynamically executing an
	unknown SQL string. The methods
	<member scope="com::sun::star::sdbc">XMultipleResults::getMoreResults()</member>
	,
	<member scope="com::sun::star::sdbc">XMultipleResults::getResultSet()</member>
	and
	<member scope="com::sun::star::sdbc">XMultipleResults::getUpdateCount()</member>
	let you navigate through multiple results.
	
	</p>
	@see com::sun::star::sdbc::XStatement 
	 @see com::sun::star::sdbc::XPreparedStatement
 */
interface XMultipleResults: com::sun::star::uno::XInterface
{ 
     
	// DocMerge from xml: method com::sun::star::sdbc::XMultipleResults::getResultSet
	/** returns the current result as a
		<type scope="com::sun::star::sdbc">ResultSet</type>
		object.
		This method should be called only once per result.
		@returns
			the ResultSet object
		@throws SQLException 
			if a database access error occurs.
	 */
	XResultSet getResultSet() raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::sdbc::XMultipleResults::getUpdateCount
	/** returns the current result as an update count.
		
		
		<p>
		If the result is a ResultSet or there are no more results, -1
		is returned. This method should be called only once per result.
		</p>
		@returns
			the current result as an update count.
		@throws SQLException 
			if a database access error occurs.
	 */
	long getUpdateCount() raises (SQLException); 
    //------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::sdbc::XMultipleResults::getMoreResults
	/** moves to a Statement's next result. It returns <TRUE/> if
		this result is a ResultSet.  This method also implicitly
		closes any current ResultSet obtained with getResultSet.
		
		<p>
		There are no more results when <code>(!getMoreResults() &amp;amp;&amp;amp;
		getUpdateCount() == -1)</code>.
		
		</p>
		@returns
			<TRUE/> if there exists more ResultSet objects
		@throws SQLException 
			if a database access error occurs.
	 */
	boolean getMoreResults() raises (SQLException); 
}; 
 
//============================================================================= 
 
}; }; }; }; 
 
/*=========================================================================== 
	$Log: XMultipleResults.idl,v $
	Revision 1.5.18.2  2003/01/21 17:46:44  mi
	merged src641 odk changes
	
	Revision 1.6  2002/10/03 13:07:01  mi
	#94968# IDL reviews merged
	
	Revision 1.5.16.1  2002/02/18 09:00:56  oj
	#97563# parameter,return value and exception description
	
	Revision 1.5  2001/03/16 16:41:35  jsc
	remove interfaceheader with uik and remove [const] in method definitions
	
	Revision 1.4  2000/12/14 12:53:39  mi
	<true></true> -> <TRUE/> and same with FALSE
	
	Revision 1.3  2000/11/08 12:43:35  mi
	moved from api
	
	Revision 1.1.1.1  2000/09/18 23:35:42  hjs
	initial import
	
	Revision 1.3  2000/09/11 11:52:43  mi
	documentation merged from XML
	 
	Revision 1.1  1999/11/24 08:41:06  dg 
	new StarDataBaseConnectivity 
	 
===========================================================================*/ 
#endif 
