/*************************************************************************
 *
 *  $RCSfile: XSQLOutput.idl,v $
 *
 *  $Revision: 1.5.18.2 $
 *
 *  last change: $Author: mi $ $Date: 2003/01/21 17:46:52 $
 *
 *  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_XSQLOutput_idl__ 
#define __com_sun_star_sdbc_XSQLOutput_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; 
};};};}; 
 
#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; 
interface XStruct; 
interface XSQLData; 
 
 
// DocMerge from xml: interface com::sun::star::io::com::sun::star::sdbc::XSQLOutput
/** is used as an output stream for writing the attributes of a user-defined
	type back to the database.  This interface, used only for custom mapping,
	is used by the driver, and its methods are never directly invoked
	by a programmer.
	
	
	<p>
	When an object of a class implementing interface 
	<type scope="com::sun::star::sdbc">XSQLData</type>
	is passed as an argument to a SQL statement, the JDBC driver calls
	<method scope="com::sun::star::sdbc">SQLData::getSQLType</method>
	to determine the kind of SQL datum being passed to the database.
	<br/>
	The driver then creates an instance of 
	<code>XSQLOutput</code>
	and passes it to the method 
	<method scope="com::sun::star::sdbc">XSQLData::writeSQL</method>
	. The method 
	<code>writeSQL</code>
	in turn calls the appropriate 
	<code>XSQLOutput.writeXXX</code>
	methods to write data from the 
	<type scope="com::sun::star::sdbc">XSQLData</type>
	object to the 
	<code>XSQLOutput</code>
	output stream as the representation of a SQL user-defined type.</p>
 */
interface XSQLOutput: com::sun::star::uno::XInterface
{ 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeString
	/** writes the next attribute to the stream as a string.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeString([in]string x) raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBoolean
	/** writes the next attribute to the stream as boolean.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeBoolean([in]boolean x) raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeByte
	/** writes the next attribute to the stream as byte.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeByte([in]byte x) raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeShort
	/** writes the next attribute to the stream as short.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeShort([in]short x) raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeInt
	/** writes the next attribute to the stream as long.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeInt([in]long x) raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeLong
	/** writes the next attribute to the stream as hyper.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeLong([in]hyper x) raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeFloat
	/** writes the next attribute to the stream as float.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeFloat([in]float x) raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeDouble
	/** writes the next attribute to the stream as double.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeDouble([in]double x) raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBytes
	/** writes the next attribute to the stream as byte sequence.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeBytes([in]sequence<byte> x) raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeDate
	/** writes the next attribute to the stream as a date.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeDate([in]com::sun::star::util::Date x) raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeTime
	/** writes the next attribute to the stream as a time.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeTime([in]com::sun::star::util::Time x) raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeTimestamp
	/** writes the next attribute to the stream as a datetime.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeTimestamp([in]com::sun::star::util::DateTime x) 
		raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBinaryStream
	/** writes the next attribute to the stream as a stream of uninterpreted
		bytes.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeBinaryStream([in]com::sun::star::io::XInputStream x) 
		raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeCharacterStream
	/** writes the next attribute to the stream as a stream of unicode string.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeCharacterStream([in]com::sun::star::io::XInputStream x) 
		raises (SQLException); 
	//------------------------------------------------------------------------- 
   	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeObject
	/** writes to the stream the data contained in the given
		<code>XSQLData</code> object.
		
		
		<p
		>When the 
		<code>XSQLData</code>
		object is 
		<NULL/>
		, this method writes an SQL NULL to the stream.
		Otherwise, it calls the 
		<member scope="com::sun::star::sdbc">XSQLData::writeSQL()</member>
		method of the given object, which
		writes the object's attributes to the stream.
		The implementation of the method 
		<code>XSQLData::writeSQL()</code>
		calls the appropriate 
		<code>XSQLOutput.writeXXX</code>
		method(s) for writing each of the object's attributes in order.
		<br/>
		The attributes must be read from an 
		<type scope="com::sun::star::sdbc">XSQLInput</type>
		input stream and written to an 
		<code>XSQLOutput</code>
		output stream in the same order in which they were
		listed in the SQL definition of the user-defined type.
		</p>
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeObject([in]XSQLData x) raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeRef
	/** writes a REF(&amp;lt;structured-type&amp;gt;) to the stream.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeRef([in]XRef x) raises (SQLException); 
  	//------------------------------------------------------------------------- 
	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeBlob
	/** writes a BLOB to the stream.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeBlob([in]XBlob x) raises (SQLException); 
	//------------------------------------------------------------------------- 
  	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeClob
	/** writes a CLOB to the stream.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeClob([in]XClob x) raises (SQLException); 
	//------------------------------------------------------------------------- 
  	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeStruct
	/** writes a structured-type to the stream.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeStruct([in]XStruct x) raises (SQLException); 
	//------------------------------------------------------------------------- 
  	 
	// DocMerge from xml: method com::sun::star::io::com::sun::star::sdbc::XSQLOutput::writeArray
	/** writes an array to the stream.
		@param x
			the value to pass to the database.
		@throws SQLException 
			if a database access error occurs.
	 */
	void writeArray([in]XArray x) raises (SQLException); 
}; 
 
//============================================================================= 
 
}; }; }; }; 
 
/*=========================================================================== 
	$Log: XSQLOutput.idl,v $
	Revision 1.5.18.2  2003/01/21 17:46:52  mi
	merged src641 odk changes
	
	Revision 1.7  2002/12/10 16:13:58  mi
	#105668# fixed dead links
	
	Revision 1.6  2002/10/03 13:07:05  mi
	#94968# IDL reviews merged
	
	Revision 1.5.16.1  2002/02/18 08:58:22  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/19 13:46:04  mi
	syntax errors in documentation fixed
	
	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:44  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:27  dg 
	chk includes 
 
	Revision 1.1  1999/11/24 08:41:13  dg 
	new StarDataBaseConnectivity 
 
===========================================================================*/ 
#endif 
