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_document_XDocumentSubStorageSupplier_idl__
28#define __com_sun_star_document_XDocumentSubStorageSupplier_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_embed_XStorage_idl__
35#include <com/sun/star/embed/XStorage.idl>
36#endif
37
38
39//=============================================================================
40
41module com {   module sun {   module star {   module document {
42
43//=============================================================================
44/** through this interface documents can provide access to their substorages
45
46    <p>
47    A temporary interface to get access to documents substorages.
48    </p>
49
50    @see DocumentInfo
51    @see StandaloneDocumentInfo
52 */
53published interface XDocumentSubStorageSupplier: com::sun::star::uno::XInterface
54{
55    //-------------------------------------------------------------------------
56    /** provides the access to a substorage with specified name
57
58        @param sStorageName
59            the name of requested substorage
60
61        @param nMode
62            a mode the storage should be opened in can take value from ::com::sun::star::embed::ElementModes
63
64        @returns
65            XStorage implementation that refers to specified substorage
66     */
67    com::sun::star::embed::XStorage getDocumentSubStorage(
68                                        [in] string aStorageName,
69                                        [in] long nMode );
70
71    //-------------------------------------------------------------------------
72    /** provides the list of substorages
73
74        @returns
75            sequence of substorages names
76     */
77    sequence< string > getDocumentSubStoragesNames()
78        raises( ::com::sun::star::io::IOException );
79
80};
81
82//=============================================================================
83
84}; }; }; };
85
86#endif
87
88