1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 *   Licensed to the Apache Software Foundation (ASF) under one or more
12 *   contributor license agreements. See the NOTICE file distributed
13 *   with this work for additional information regarding copyright
14 *   ownership. The ASF licenses this file to you under the Apache
15 *   License, Version 2.0 (the "License"); you may not use this file
16 *   except in compliance with the License. You may obtain a copy of
17 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19#ifndef __com_sun_star_document_XBinaryStreamResolver_idl__
20#define __com_sun_star_document_XBinaryStreamResolver_idl__
21
22#include <com/sun/star/uno/XInterface.idl>
23#include <com/sun/star/io/XInputStream.idl>
24#include <com/sun/star/io/XOutputStream.idl>
25
26
27module com {  module sun {  module star {  module document {
28
29
30/**
31    <p>This interface encapsulates functionality to get/resolve binary data streams.
32    It is used to transform binary data to a URL or to transform a URL to binary
33    data. The binary data is represented through input and output streams.</p>
34
35    <p>In the case of transforming a URL to binary data, the <code>getInputStream</code>
36    method is used. This returns a com::sun::star::io::XInputStream
37    from which the binary data, transformed from the given URL, can be read.</p>
38
39    <p>In the case of transforming binary data to a URL, a
40    com::sun::star::io::XOutputStream is created first to write
41    the binary data to. After this, the <code>resolveOutputStream</code> method can
42    be used to transform the binary data, represented through the
43    com::sun::star::io::XOutputStream interface, to a URL.</p>
44 */
45published interface XBinaryStreamResolver: com::sun::star::uno::XInterface
46{
47    /** converts the given URL from the source URL namespace to an input stream,
48        from which binary data can be read
49    */
50    com::sun::star::io::XInputStream getInputStream( [in] string aURL );
51
52    /** creates an output stream, to which binary data can be written.
53        After writing, a URL can be retrieved by a call to
54        XBinaryStreamResolver::resolveOutputStream().
55    */
56    com::sun::star::io::XOutputStream createOutputStream();
57
58    /** converts the output stream, data has been written to, to a URL in
59        source URL namespace.
60    */
61    string resolveOutputStream( [in] com::sun::star::io::XOutputStream aBinaryStream );
62};
63
64
65}; }; }; };
66
67#endif
68
69/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
70