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