1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_io_XOutputStream_idl__
28#define __com_sun_star_io_XOutputStream_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_io_NotConnectedException_idl__
35#include <com/sun/star/io/NotConnectedException.idl>
36#endif
37
38#ifndef __com_sun_star_io_BufferSizeExceededException_idl__
39#include <com/sun/star/io/BufferSizeExceededException.idl>
40#endif
41
42
43//=============================================================================
44
45module com {  module sun {  module star {  module io {
46
47//=============================================================================
48
49// DocMerge from xml: interface com::sun::star::io::XOutputStream
50/** This is the basic interface to write data to a stream.
51    <p>
52    See the <a href="http://udk.openoffice.org/common/man/concept/streams.html">
53    streaming document</a> for further information on chaining and piping streams.
54 */
55published interface XOutputStream: com::sun::star::uno::XInterface
56{
57	//-------------------------------------------------------------------------
58
59	// DocMerge from xml: method com::sun::star::io::XOutputStream::writeBytes
60	/** writes the whole sequence to the stream. (blocking call)
61	 */
62	void writeBytes( [in] sequence<byte> aData )
63			raises( com::sun::star::io::NotConnectedException,
64					com::sun::star::io::BufferSizeExceededException,
65					com::sun::star::io::IOException);
66
67	//-------------------------------------------------------------------------
68
69	// DocMerge from xml: method com::sun::star::io::XOutputStream::flush
70	/** flushes out of the stream any data that may exist in buffers.
71
72        <p>The semantics of this method are rather vague.  See
73        <member scope="com::sun::star::io">
74        XAsyncOutputMonitor::waitForCompletion</member> for a similar method
75        with very specific semantics, that is useful in certain scenarios.</p>
76	 */
77	void flush()
78			raises( com::sun::star::io::NotConnectedException,
79					com::sun::star::io::BufferSizeExceededException,
80					com::sun::star::io::IOException);
81
82	//-------------------------------------------------------------------------
83
84	// DocMerge from xml: method com::sun::star::io::XOutputStream::closeOutput
85	/** gets called to indicate that all data has been written.
86
87		<p>If this method has not yet been called, no attached
88		<type>XInputStream</type> receives an EOF signal. No further
89		bytes may be written after this method has been called.</p>
90	 */
91	void closeOutput()
92			raises( com::sun::star::io::NotConnectedException,
93					com::sun::star::io::BufferSizeExceededException,
94					com::sun::star::io::IOException);
95
96};
97
98//=============================================================================
99
100}; }; }; };
101
102/*=============================================================================
103
104=============================================================================*/
105#endif
106