1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_embed_XHierarchicalStorageAccess_idl__
#define __com_sun_star_embed_XHierarchicalStorageAccess_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_io_XStream_idl__
#include <com/sun/star/io/XStream.idl>
#endif
#ifndef __com_sun_star_embed_XExtendedStorageStream_idl__
#include <com/sun/star/embed/XExtendedStorageStream.idl>
#endif
#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_embed_StorageWrappedTargetException_idl__
#include <com/sun/star/embed/StorageWrappedTargetException.idl>
#endif
#ifndef __com_sun_star_embed_InvalidStorageException_idl__
#include <com/sun/star/embed/InvalidStorageException.idl>
#endif
#ifndef __com_sun_star_packages_WrongPasswordException_idl__
#include <com/sun/star/packages/WrongPasswordException.idl>
#endif
#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif
#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#endif
#ifndef __com_sun_star_container_ElementExistException_idl__
#include <com/sun/star/container/ElementExistException.idl>
#endif
#ifndef __com_sun_star_packages_NoEncryptionException_idl__
#include <com/sun/star/packages/NoEncryptionException.idl>
#endif
//============================================================================
module com { module sun { module star { module embed {
//============================================================================
/** This interface allows hierarchical access to storage tree.
<p>
Currently only streams can be opened using this interface.
</p>
<p>
The hierarchical access can not be mixed with a normal access. Thus when
in a storage a stream with a path "a/b/c" is accessed using hierarchical
access, another stream "a/b/d" can also be opened with hierarchical
access ( if it is still not opened ), but the substorage "a" can not be
opened ( it is locked by hierarchical access ).
</p>
*/
interface XHierarchicalStorageAccess
{
// METHODS
//
// -----------------------------------------------------------------------
/** allows to get access to a child stream of the storage, using
hierarchical path.
<p>
In case the stream is open in readonly mode the
<method scope="com::sun::star::io">XStream::getOutputStream</method>
method will return an empty reference.
</p>
@param sStreamPath
the path to the substream that should be open
@param nOpenMode
a mode the stream should be open in,
can be a combination of <type>ElementModes</type> values
@throws ::com::sun::star::embed::InvalidStorageException
this storage is in invalid state for any reason
@throws ::com::sun::star::lang::IllegalArgumentException
one of provided arguments is illegal
@throws ::com::sun::star::packages::WrongPasswordException
the provided password is wrong
@throws ::com::sun::star::io::IOException
in case of io errors during stream opening
@throws ::com::sun::star::embed::StorageWrappedTargetException
wraps other exceptions
*/
XExtendedStorageStream openStreamElementByHierarchicalName(
[in] string sStreamPath,
[in] long nOpenMode )
raises( ::com::sun::star::embed::InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::packages::WrongPasswordException,
::com::sun::star::io::IOException,
::com::sun::star::embed::StorageWrappedTargetException );
// -----------------------------------------------------------------------
/** allows to get access to a child encrypted stream with password using
hierarchical path.
<p>
If storage does not allow any encryption this method will always throw
<type scope="com::sun::star::packages">NoEncryptionException</type>.
</p>
<p>
In case the stream is open in readonly mode the
<method scope="com::sun::star::io">XStream::getOutputStream</method>
method will return an empty reference.
</p>
@param sStreamPath
the path to the substream that should be open
@param nOpenMode
a mode the stream should be open in,
can be a combination of <type>ElementModes</type> values
@param sPassword
this parameter allowes to specify a reading password for the
stream, the password must be a correct one, otherwise an
exception will be thrown
@throws ::com::sun::star::embed::InvalidStorageException
this storage is in invalid state for any reason
@throws ::com::sun::star::lang::IllegalArgumentException
one of provided arguments is illegal
@throws ::com::sun::star::packages::NoEncryptionException
the stream is not encrypted
@throws ::com::sun::star::packages::WrongPasswordException
the provided password is wrong
@throws ::com::sun::star::io::IOException
in case of io errors during stream opening
@throws ::com::sun::star::embed::StorageWrappedTargetException
wraps other exceptions
*/
XExtendedStorageStream openEncryptedStreamElementByHierarchicalName(
[in] string sStreamName,
[in] long nOpenMode,
[in] string sPassword )
raises( ::com::sun::star::embed::InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::packages::NoEncryptionException,
::com::sun::star::packages::WrongPasswordException,
::com::sun::star::io::IOException,
::com::sun::star::embed::StorageWrappedTargetException );
// -----------------------------------------------------------------------
/** removes a stream specified by hierarchical name from a storage.
@param sElementPath
the path to the element to remove
@throws ::com::sun::star::embed::InvalidStorageException
this storage is in invalid state for eny reason
@throws ::com::sun::star::lang::IllegalArgumentException
an illegal argument is provided
@throws ::com::sun::star::container::NoSuchElementException
there is no element with such name
@throws ::com::sun::star::io::IOException
in case of io errors during removing
@throws ::com::sun::star::embed::StorageWrappedTargetException
wraps other exceptions
*/
void removeStreamElementByHierarchicalName( [in] string sElementPath )
raises( ::com::sun::star::embed::InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::io::IOException,
::com::sun::star::embed::StorageWrappedTargetException );
};
//============================================================================
}; }; }; };
#endif
|
