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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
module com { module sun { module star { module embed {
/** This interface represents main storage functionality.
*/
published interface XStorage
{
// INTERFACES
/** allows to get list of child elements and to check if an element with a
specified name exists in a storage.
<p>
It is also possible to use this interface to get read access to
a child element by
com::sun::star::container::XNameAccess::getByName()
call. But the recommended way is to use XStorage
interface for this purpose.
</p>
*/
interface ::com::sun::star::container::XNameAccess;
/** allows to control and track lifetime of the storage.
<p>
In case a storage is disposed any call to its methods should result
in com::sun::star::lang::DisposedException.
</p>
*/
interface ::com::sun::star::lang::XComponent;
// METHODS
/** allows to copy current storage to another one
<p>
The destination storage contents are overwritten.
After the successful copying the target storage is automatically
committed if it implements transacted access.
</p>
@param xDest
a destination storage this storage must be copied to.
@throws ::com::sun::star::embed::InvalidStorageException
this storage is in invalid state for any reason
@throws ::com::sun::star::lang::IllegalArgumentException
an illegal argument is provided
@throws ::com::sun::star::io::IOException
in case of io errors during copying
@throws ::com::sun::star::embed::StorageWrappedTargetException
wraps other exception acquired during copying
*/
void copyToStorage( [in] XStorage xDest )
raises( ::com::sun::star::embed::InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::io::IOException,
::com::sun::star::embed::StorageWrappedTargetException );
/** allows to get access to a child stream of the storage.
<p>
In case the stream is open in readonly mode the
com::sun::star::io::XStream::getOutputStream()
method will return an empty reference.
</p>
@param sStreamName
the name of the substream that should be open
@param nOpenMode
a mode the stream should be open in,
can be a combination of ElementModes 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
*/
::com::sun::star::io::XStream openStreamElement(
[in] string sStreamName,
[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.
<p>
If storage does not allow any encryption this method will always throw
com::sun::star::packages::NoEncryptionException.
</p>
<p>
In case the stream is open in readonly mode the
com::sun::star::io::XStream::getOutputStream()
method will return an empty reference.
</p>
@param sStreamName
the name of the substream that should be open
@param nOpenMode
a mode the stream should be open in,
can be a combination of ElementModes values
@param sPassword
this parameter allows 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
*/
::com::sun::star::io::XStream openEncryptedStreamElement(
[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 );
/** allows to get access to a child storage.
<p>
The opened substorage must support specified in "nOpenMode" access
modes. It can support "read" mode in addition. But any child element
can support one of those modes only in case this mode is supported by
parent storage.
</p>
@param sStorName
the name of the storage that should be open
@param nOpenMode
a mode the storage should be open in
@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::io::IOException
in case of io errors during stream opening
@throws ::com::sun::star::embed::StorageWrappedTargetException
wraps other exceptions
*/
XStorage openStorageElement( [in] string sStorName,
[in] long nOpenMode )
raises( ::com::sun::star::embed::InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::io::IOException,
::com::sun::star::embed::StorageWrappedTargetException );
/** allows to get readonly copy of a child stream of the storage.
<p>
The stream is open in readonly mode so the
com::sun::star::io::XStream::getOutputStream()
method will return an empty reference.
</p>
@param sStreamName
the name of the substream that should be copied
@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
*/
::com::sun::star::io::XStream cloneStreamElement( [in] string sStreamName )
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 readonly copy of a child encrypted stream with password.
<p>
If storage does not allow any encryption this method will always throw
com::sun::star::packages::NoEncryptionException.
</p>
<p>
The stream is open in readonly mode so the
com::sun::star::io::XStream::getOutputStream()
method will return an empty reference.
</p>
<p>
This method allows to specify reading password for the child stream
explicitly.
</p>
@param sStreamName
the name of the substream that should be copied
@param sPassword
this parameter allows 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
*/
::com::sun::star::io::XStream cloneEncryptedStreamElement(
[in] string sStreamName,
[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 );
/** allows to get copy of this storage at the state of its last commit.
<p>
This method makes sense only for services implementations that allow
transaction in the storage.
</p>
@param xTargetStorage
the target storage that will be filled in with copy.
@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::io::IOException
in case of io errors during copying
@throws ::com::sun::star::embed::StorageWrappedTargetException
wraps other exceptions
*/
void copyLastCommitTo( [in] XStorage xTargetStorage )
raises( ::com::sun::star::embed::InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::io::IOException,
::com::sun::star::embed::StorageWrappedTargetException );
/** allows to get copy of a child storage at the state of its last commit.
<p>
This method makes sense only for services implementations that allow
transaction in the storage.
</p>
@param sStorName
the name of the storage that should be copied
@param xTargetStorage
the target storage that will be filled in with copy
@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::io::IOException
in case of io errors during copying
@throws ::com::sun::star::embed::StorageWrappedTargetException
wraps other exceptions
*/
void copyStorageElementLastCommitTo(
[in] string sStorName,
[in] XStorage xTargetStorage )
raises( ::com::sun::star::embed::InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::io::IOException,
::com::sun::star::embed::StorageWrappedTargetException );
/** allows to check if an element is a child stream with specified name.
<p>
In case there is no child element with such name an exception will be
thrown.
</p>
@param sElementName
the name of the element to check
@returns
`TRUE` in case the element is a stream
`FALSE` - the element is a storage
@throws ::com::sun::star::container::NoSuchElementException
there is no element with such name
@throws ::com::sun::star::lang::IllegalArgumentException
an illegal argument is provided
@throws ::com::sun::star::embed::InvalidStorageException
this storage is in invalid state for any reason
*/
boolean isStreamElement( [in] string sElementName )
raises( ::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::embed::InvalidStorageException );
/** allows to check if an element is a child storage with specified name.
<p>
In case there is no child element with such name an exception will be
thrown.
</p>
@param sElementName
the name of the element to check
@returns
`TRUE` in case the element is a storage
`FALSE` - the element is a stream
@throws ::com::sun::star::container::NoSuchElementException
there is no element with such name
@throws ::com::sun::star::lang::IllegalArgumentException
an illegal argument is provided
@throws ::com::sun::star::embed::InvalidStorageException
this storage is in invalid state for any reason
*/
boolean isStorageElement( [in] string sElementName )
raises( ::com::sun::star::container::NoSuchElementException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::embed::InvalidStorageException );
/** removes an element from a storage.
@param sElementName
the name of the element to remove
@throws ::com::sun::star::embed::InvalidStorageException
this storage is in invalid state for any 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 removeElement( [in] string sElementName )
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 );
/** renames an element in a storage.
@param sElementName
the old name of the element to rename
@param sNewName
the new name of the element to rename
@throws ::com::sun::star::embed::InvalidStorageException
this storage is in invalid state for any reason
@throws ::com::sun::star::lang::IllegalArgumentException
an illegal argument is provided
@throws ::com::sun::star::container::NoSuchElementException
there is no element with old name in this storage
@throws ::com::sun::star::container::ElementExistException
an element with new name already exists in this storage
@throws ::com::sun::star::io::IOException
in case of io errors during renaming
@throws ::com::sun::star::embed::StorageWrappedTargetException
wraps other exceptions
*/
void renameElement( [in] string sElementName, [in] string sNewName )
raises( ::com::sun::star::embed::InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::container::ElementExistException,
::com::sun::star::io::IOException,
::com::sun::star::embed::StorageWrappedTargetException );
/** allows to copy an entry from one storage to another.
<p>
If target element supports transacted mode it must be committed by this
method after successful copying.
</p>
@param sElementName
the name of the element in this storage
@param xDest
a destination storage
@param sNewName
the name of the result element in destination storage
@throws ::com::sun::star::embed::InvalidStorageException
this storage is in invalid state for any reason
@throws ::com::sun::star::container::NoSuchElementException
there is no specified source element in this storage
@throws ::com::sun::star::container::ElementExistException
an element with specified destination name already exists in destination storage
@throws ::com::sun::star::io::IOException
in case of io errors during copying
@throws ::com::sun::star::embed::StorageWrappedTargetException
wraps other exceptions
*/
void copyElementTo(
[in] string sElementName,
[in] XStorage xDest,
[in] string sNewName )
raises( ::com::sun::star::embed::InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::container::ElementExistException,
::com::sun::star::io::IOException,
::com::sun::star::embed::StorageWrappedTargetException );
/** allows to move an entry from one storage to another.
<p>
If target element supports transacted mode it must be committed by this
method after successful moving.
</p>
@param sElementName
the name of the element in this storage
@param xDest
a destination storage
@param sNewName
the name of the result element in destination storage
@throws ::com::sun::star::embed::InvalidStorageException
this storage is in invalid state for any reason
@throws ::com::sun::star::container::NoSuchElementException
there is no specified source element in this storage
@throws ::com::sun::star::container::ElementExistException
an element with specified destination name already exists in destination storage
@throws ::com::sun::star::io::IOException
in case of io errors during moving
@throws ::com::sun::star::embed::StorageWrappedTargetException
wraps other exceptions
*/
void moveElementTo(
[in] string sElementName,
[in] XStorage xDest,
[in] string sNewName )
raises( ::com::sun::star::embed::InvalidStorageException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::container::NoSuchElementException,
::com::sun::star::container::ElementExistException,
::com::sun::star::io::IOException,
::com::sun::star::embed::StorageWrappedTargetException );
};
}; }; }; };
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
