1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_document_XDocumentSubStorageSupplier_idl__
24#define __com_sun_star_document_XDocumentSubStorageSupplier_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_embed_XStorage_idl__
31#include <com/sun/star/embed/XStorage.idl>
32#endif
33
34
35//=============================================================================
36
37module com {   module sun {   module star {   module document {
38
39//=============================================================================
40/** through this interface documents can provide access to their substorages
41
42    <p>
43    A temporary interface to get access to documents substorages.
44    </p>
45
46    @see DocumentInfo
47    @see StandaloneDocumentInfo
48 */
49published interface XDocumentSubStorageSupplier: com::sun::star::uno::XInterface
50{
51    //-------------------------------------------------------------------------
52    /** provides the access to a substorage with specified name
53
54        @param sStorageName
55            the name of requested substorage
56
57        @param nMode
58            a mode the storage should be opened in can take value from ::com::sun::star::embed::ElementModes
59
60        @returns
61            XStorage implementation that refers to specified substorage
62     */
63    com::sun::star::embed::XStorage getDocumentSubStorage(
64                                        [in] string aStorageName,
65                                        [in] long nMode );
66
67    //-------------------------------------------------------------------------
68    /** provides the list of substorages
69
70        @returns
71            sequence of substorages names
72     */
73    sequence< string > getDocumentSubStoragesNames()
74        raises( ::com::sun::star::io::IOException );
75
76};
77
78//=============================================================================
79
80}; }; }; };
81
82#endif
83
84