/*************************************************************************
 *
 *  $RCSfile: ObjectInputStream.idl,v $
 *
 *  $Revision: 1.9 $
 *
 *  last change: $Author: hr $ $Date: 2003/03/27 17:35:18 $
 *
 *  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_ObjectInputStream_idl__ 
#define __com_sun_star_io_ObjectInputStream_idl__ 
 
#ifndef __com_sun_star_io_XObjectInputStream_idl__ 
#include <com/sun/star/io/XObjectInputStream.idl> 
#endif 
 
#ifndef __com_sun_star_io_XActiveDataSink_idl__ 
#include <com/sun/star/io/XActiveDataSink.idl> 
#endif 
 
#ifndef __com_sun_star_io_XConnectable_idl__ 
#include <com/sun/star/io/XConnectable.idl> 
#endif 
 
#ifndef __com_sun_star_io_XMarkableStream_idl__ 
#include <com/sun/star/io/XMarkableStream.idl> 
#endif 
 
 
//============================================================================= 
 
 module com {  module sun {  module star {  module io {  
 
//============================================================================= 
 
// DocMerge from xml: service com::sun::star::io::ObjectInputStream
/** is a stream which allows reading the data of persistent objects.
	
	<p>Implementations of this service must fulfill the specifications of the 
	<type>DataInputStream</type> service. It must be chained to an 
	<type>XMarkableStream</type>. Therefore, it provides the 
	<type>XMarkableStream</type> interface, and delegates the calls to the 
	chained object.  </p>

	<p>The written objects are held until this instance is destroyed.
	The references to the objects are read as four-byte integers.
	Data format reads:</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
	...                      // skipping additional data
	</pre>
	
	@guarantees
	<ul>
		<li>-thread safe</li>
		<li>-allow buffer size is 2 ^ 31 -1</li>
		<li>-maximum object reference identifier must be the number of objects. </li>
		<li>-object reference identifier 0 indicates no object</li>
		<li>-skip addition data</li>
		<li>-set the stream position behind the object data</li>
	</ul>
 */
service ObjectInputStream
{ 
    /** allows to read the data from the stream.
     */
	interface com::sun::star::io::XObjectInputStream; 
	
	/** allows to set the underlying inputstream */
	interface com::sun::star::io::XActiveDataSink; 
	
	/** allows to navigate via a chain of streams */
	interface com::sun::star::io::XConnectable; 
	
	/** allows to set marks within the stream. The implementation
     may forward calls to this interface to a chained markablestream. */
	interface com::sun::star::io::XMarkableStream; 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
/*============================================================================= 
 
=============================================================================*/ 
#endif 
