/*************************************************************************
 *
 *  $RCSfile: XRow.idl,v $
 *
 *  $Revision: 1.6.4.2 $
 *
 *  last change: $Author: mi $ $Date: 2003/01/21 17:46:49 $
 *
 *  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_XRow_idl__ 
#define __com_sun_star_sdbc_XRow_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_util_Date_idl__ 
#include <com/sun/star/util/Date.idl> 
#endif 
 
#ifndef __com_sun_star_util_DateTime_idl__ 
#include <com/sun/star/util/DateTime.idl> 
#endif 
 
#ifndef __com_sun_star_util_Time_idl__ 
#include <com/sun/star/util/Time.idl> 
#endif 
 
 module com {  module sun {  module star {  module io { 
interface XInputStream; 
};};};}; 
 
 module com {  module sun {  module star {  module container { 
interface XNameAccess; 
};};};}; 
 
#ifndef __com_sun_star_sdbc_SQLException_idl__ 
#include <com/sun/star/sdbc/SQLException.idl> 
#endif 
 
 module com {  module sun {  module star {  module sdbc { 
 
interface XRef; 
interface XArray; 
interface XBlob; 
interface XClob; 
 
 
// DocMerge from xml: interface com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow
/** is used to access data which is collected in a row.
	All methods raise a 
	<type scope="com::sun::star::sdbc">SQLException</type>
	if a database access error occurs.
 */
interface XRow: com::sun::star::uno::XInterface
{ 
	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::wasNull
	/** reports whether the last column read had a value of SQL NULL.
		Note that you must first call getXXX on a column to try to read
		its value and then call wasNull() to see if the value read was
		SQL NULL.

		@returns
			<TRUE/> if last column read was SQL NULL and <FALSE/> otherwise
		@throws SQLException 
				if a database access error occurs.
	 */
	boolean wasNull() raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getString
	/** gets the value of a column in the current row as a string.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	string getString([in]long columnIndex) raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBoolean
	/** gets the value of a column in the current row as boolean.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	boolean getBoolean([in]long columnIndex) raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getByte
	/** get the value of a column in the current row as a byte.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	byte getByte([in]long columnIndex) raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getShort
	/** gets the value of a column in the current row as a short.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	short getShort([in]long columnIndex) raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getInt
	/** get the value of a column in the current row as an integer.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	long getInt([in]long columnIndex) raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getLong
	/** get the value of a column in the current row as a long.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	hyper getLong([in]long columnIndex) raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getFloat
	/** gets the value of a column in the current row as a float.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	float getFloat([in]long columnIndex) raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getDouble
	/** gets the value of a column in the current row as a double.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	double getDouble([in]long columnIndex) raises (SQLException); 
	//------------------------------------------------------------------------- 
	 
	// DocMerge from idl: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBytes
	/** gets the value of a column in the current row as a byte array. 
		     The bytes represent the raw values returned by the driver. 
			 @param columnIndex 
				the first column is 1, the second is 2, ... 
		     @returns 
				the column value; if the value is SQL NULL, the result is empty. 
		     @throws SQLException 
				if a database access error occurs.
	 */
	sequence<byte> getBytes([in]long columnIndex) raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getDate
	/** gets the value of a column in the current row as a date object.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	com::sun::star::util::Date getDate([in]long columnIndex) 
		raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getTime
	/** gets the value of a column in the current row as a time object.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	com::sun::star::util::Time getTime([in]long columnIndex) 
		raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getTimestamp
	/** gets the value of a column in the current row as a datetime object.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	com::sun::star::util::DateTime getTimestamp([in]long columnIndex) 
		raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBinaryStream
	/** gets the value of a column in the current row as a stream of
		uninterpreted bytes. The value can then be read in chunks from the
		stream. This method is particularly suitable for retrieving large
		LONGVARBINARY values.
		
		
		<p>
		<b>Note:</b> All the data in the returned stream must be
		read prior to getting the value of any other column. The next
		call to a get method implicitly closes the stream. Also, a
		stream may return 0 when the method 
		<member scope="com::sun::star::io">XInputStream::available()</member>
		is called whether there is data
		available or not.
		</p>
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	com::sun::star::io::XInputStream getBinaryStream([in]long columnIndex) 
        raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getCharacterStream
	/** gets the value of a column in the current row as a stream of
		uninterpreted bytes. The value can then be read in chunks from the
		stream. This method is particularly suitable for retrieving large
		LONGVARBINARY or LONGVARCHAR values.
		
		
		<p>
		<b>Note:</b> All the data in the returned stream must be
		read prior to getting the value of any other column. The next
		call to a get method implicitly closes the stream. Also, a
		stream may return 0 when the method 
		<member scope="com::sun::star::io">XInputStream::available()</member>
		is called whether there is data
		available or not.
		</p>
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	com::sun::star::io::XInputStream getCharacterStream([in]long columnIndex) 
        raises (SQLException); 
	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getObject
	/** returns the value of a column in the current row as an object.
		This method uses the given 
		<code>Map</code>
		object for the custom mapping of the SQL structure or distinct type
		that is being retrieved.
		@param columnIndex
			the first column is 1, the second is 2,
		@param typeMap
			the map of types which should be used to get the column value
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	any getObject([in]long columnIndex, 
			      [in]com::sun::star::container::XNameAccess typeMap) 
		raises (SQLException); 
    //------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getRef
	/** gets a REF(&amp;lt;structured-type&amp;gt;) column value from the current row.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	XRef getRef([in]long columnIndex) raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getBlob
	/** gets a BLOB value in the current row.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	XBlob getBlob([in]long columnIndex) raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getClob
	/** gets a CLOB value in the current row of this 
		<code>ResultSet</code> 
		object.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
			if a database access error occurs.
	 */
	XClob getClob([in]long columnIndex) raises (SQLException); 
	//------------------------------------------------------------------------- 
     
	// DocMerge from xml: method com::sun::star::io::com::sun::star::container::com::sun::star::sdbc::XRow::getArray
	/** gets a SQL ARRAY value from the current row of this 
		<code>ResultSet</code> 
		object.
		@param columnIndex
			the first column is 1, the second is 2,
		@returns
			the column value; if the value is SQL NULL, the result is null
		@throws SQLException 
				if a database access error occurs.
	 */
	XArray getArray([in]long columnIndex) raises (SQLException); 
}; 
 
//============================================================================= 
 
}; }; }; }; 
 
/*=========================================================================== 
	$Log: XRow.idl,v $
	Revision 1.6.4.2  2003/01/21 17:46:49  mi
	merged src641 odk changes
	
	Revision 1.7  2002/10/03 13:07:04  mi
	#94968# IDL reviews merged
	
	Revision 1.6.2.1  2002/02/18 08:58:22  oj
	#97563# parameter,return value and exception description
	
	Revision 1.6  2001/11/01 16:46:46  mi
	proofreading and corrections from Richard Holt
	
	Revision 1.5  2001/10/16 06:40:03  oj
	#76791# documentation added
	
	Revision 1.4  2001/03/16 16:41:35  jsc
	remove interfaceheader with uik and remove [const] in method definitions
	
	Revision 1.3  2000/11/08 12:43:35  mi
	moved from api
	
	Revision 1.1.1.1  2000/09/18 23:35:43  hjs
	initial import
	
	Revision 1.6  2000/09/11 11:52:43  mi
	documentation merged from XML
	 
	Revision 1.4  1999/12/20 16:11:35  dg 
	#70278# changes in API 
	 
	Revision 1.3  1999/12/13 13:47:55  dg 
	#70278# XSQLErrorBroadcaster removed 
 
	Revision 1.2  1999/11/24 11:33:26  dg 
	chk includes 
 
	Revision 1.1  1999/11/24 08:41:09  dg 
	new StarDataBaseConnectivity 
 
===========================================================================*/ 
#endif 
