/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XOutputStream.idl,v $
 *
 *  $Revision: 1.13 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-09 15:33:22 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/
#ifndef __com_sun_star_io_XOutputStream_idl__
#define __com_sun_star_io_XOutputStream_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_io_NotConnectedException_idl__
#include <com/sun/star/io/NotConnectedException.idl>
#endif

#ifndef __com_sun_star_io_BufferSizeExceededException_idl__
#include <com/sun/star/io/BufferSizeExceededException.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module io {

//=============================================================================

// DocMerge from xml: interface com::sun::star::io::XOutputStream
/** This is the basic interface to write data to a stream.
    <p>
    See the <a href="http://udk.openoffice.org/common/man/concept/streams.html">
    streaming document</a> for further information on chaining and piping streams.
 */
published interface XOutputStream: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::io::XOutputStream::writeBytes
    /** writes the whole sequence to the stream. (blocking call)
     */
    void writeBytes( [in] sequence<byte> aData )
            raises( com::sun::star::io::NotConnectedException,
                    com::sun::star::io::BufferSizeExceededException,
                    com::sun::star::io::IOException);

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::io::XOutputStream::flush
    /** flushes out of the stream any data that may exist in buffers.

        <p>The semantics of this method are rather vague.  See
        <member scope="com::sun::star::io">
        XAsyncOutputMonitor::waitForCompletion</member> for a similar method
        with very specific semantics, that is useful in certain scenarios.</p>
     */
    void flush()
            raises( com::sun::star::io::NotConnectedException,
                    com::sun::star::io::BufferSizeExceededException,
                    com::sun::star::io::IOException);

    //-------------------------------------------------------------------------

    // DocMerge from xml: method com::sun::star::io::XOutputStream::closeOutput
    /** gets called to indicate that all data has been written.

        <p>If this method has not yet been called, no attached
        <type>XInputStream</type> receives an EOF signal. No further
        bytes may be written after this method has been called.</p>
     */
    void closeOutput()
            raises( com::sun::star::io::NotConnectedException,
                    com::sun::star::io::BufferSizeExceededException,
                    com::sun::star::io::IOException);

};

//=============================================================================

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif
