/*************************************************************************
 *
 *  $RCSfile: ObjectOutputStream.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: jbu $ $Date: 2002/01/18 13:41:36 $
 *
 *  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_io_ObjectOutputStream_idl__ 
#define __com_sun_star_io_ObjectOutputStream_idl__ 
 
#ifndef __com_sun_star_io_XObjectOutputStream_idl__ 
#include <com/sun/star/io/XObjectOutputStream.idl> 
#endif 
 
#ifndef __com_sun_star_io_XActiveDataSource_idl__ 
#include <com/sun/star/io/XActiveDataSource.idl> 
#endif 
 
#ifndef __com_sun_star_io_XConnectable_idl__ 
#include <com/sun/star/io/XConnectable.idl> 
#endif 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module io {  
 
//============================================================================= 
 
// DocMerge from xml: service com::sun::star::io::ObjectOutputStream
/** is a stream which allows writing the data of persistent objects.
	
	<p>Implementations of this service must fulfill the specifications of the 
	<type>DataOutputStream</type> service; futhermore, the stream needs to be chained to a 
	<type>XMarkableStream</type>. Therefore, it also provides the <type>XMarkableStream</type>
	interface, but it delegates the calls to the chained object.
	The written objects are held until this instance is destroyed.
	The references to the objects are written as four-byte integers 
	and begin at 1. Data format is written: </p>

	<pre>
	short   InfoLength
	long    ObjectReference // 0 indicates no object
	UTF     ServiceName     // length of 0 indicates this is only a reference
	long    ObjectLength    // 0 if it is a reference or no object, otherwise the len of the object data
	Object  ObjectData      // the data of the object
	</pre>
	
	@garantees
	<ul>
		<li>-thread safe </li>
		<li>-allow buffer size is 2 ^ 31 -1 </li> 
		<li>-maximum object reference identifier is the number of objects.  </li> 
		<li>-object reference identifier 0 indicates no object </li>
	</ul>
 */
service ObjectOutputStream
{ 
    /** allows to write the data to the stream.
     */
	interface com::sun::star::io::XObjectOutputStream; 
	
	/** allows to set the underlying outputstream */
	interface com::sun::star::io::XActiveDataSource; 
	
	/** allows to navigate via a chain of streams */
	interface com::sun::star::io::XConnectable; 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
/*============================================================================= 
 
	$Log: ObjectOutputStream.idl,v $
	Revision 1.7  2002/01/18 13:41:36  jbu
	#96701# DataInputStream.idl DataOutputStream.idl MarkableInputStream.idl MarkableOutputStream.idl ObjectInputStream.idl ObjectOutputStream.idl Pipe.idl Pump.idl XDataInputStream.idl XDataOutputStream.idl XInputStream.idl XOutputStream.idl XPersistObject.idl
	
	Revision 1.6  2001/11/16 14:45:32  mi
	proofing by Richard Holt
	
	Revision 1.5  2000/12/11 16:09:49  mi
	documentation syntax fixed and some minor semantic documentation fixes
	
	Revision 1.4  2000/11/08 12:28:36  mi
	moved from api
	
	Revision 1.1.1.1  2000/09/18 23:35:23  hjs
	initial import
	
	Revision 1.4  2000/09/11 11:52:31  mi
	documentation merged from XML
	 
	Revision 1.2  2000/02/17 17:19:43  mi 
	proofreading in layouted version 
	 
	Revision 1.1.1.1  1999/11/11 09:48:43  jsc 
	new 
	 
 
=============================================================================*/ 
#endif 
