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
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: content.hxx,v $
* $Revision: 1.20 $
*
* 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 _UCBHELPER_CONTENT_HXX
#define _UCBHELPER_CONTENT_HXX
#include "rtl/ref.hxx"
#include <com/sun/star/ucb/ContentCreationException.hpp>
#include <com/sun/star/ucb/CommandAbortedException.hpp>
#include <com/sun/star/io/XStream.hpp>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include "ucbhelper/ucbhelperdllapi.h"
namespace com { namespace sun { namespace star { namespace beans {
class XPropertySetInfo;
} } } }
namespace com { namespace sun { namespace star { namespace io {
class XActiveDataSink;
class XOutputStream;
class XInputStream;
} } } }
namespace com { namespace sun { namespace star { namespace sdbc {
class XResultSet;
class XRow;
} } } }
namespace com { namespace sun { namespace star { namespace ucb {
class XCommandEnvironment;
class XCommandInfo;
class XContent;
class XContentIdentifier;
class XDynamicResultSet;
class XAnyCompareFactory;
struct ContentInfo;
struct NumberedSortingInfo;
} } } }
namespace ucbhelper
{
//=========================================================================
/**
* These are the possible values for the parameter eMode of method
* ucbhelper::Content::createCursor.
*/
enum ResultSetInclude
{
INCLUDE_FOLDERS_ONLY,
INCLUDE_DOCUMENTS_ONLY,
INCLUDE_FOLDERS_AND_DOCUMENTS
};
/**
* These are the possible values for the parameter eOperation of method
* ucbhelper::Content::insertNewContent.
*/
enum InsertOperation
{
InsertOperation_COPY, // copy source data
InsertOperation_MOVE, // move source data
InsertOperation_LINK // create a link to source
};
//=========================================================================
class Content_Impl;
/**
* This class simplifies access to UCB contents by providing a more
* convenient API for frequently used functionality then the "raw"
* UCB-API does.
*/
class UCBHELPER_DLLPUBLIC Content
{
rtl::Reference< Content_Impl > m_xImpl;
protected:
::com::sun::star::uno::Any createCursorAny( const ::com::sun::star::uno::Sequence<
rtl::OUString >& rPropertyNames,
ResultSetInclude eMode )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
::com::sun::star::uno::Any createCursorAny( const ::com::sun::star::uno::Sequence<
sal_Int32 >& rPropertyHandles,
ResultSetInclude eMode )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
public:
/**
* Constructor.
*/
Content();
/**
* Constructor.
*
* @param rURL is the URL of the content to create.
* @param rEnv is the environment to use for commands executed by the
* content. The command environment is used by the content
* implementation to interact with the client and to propagate
* errors.
*/
Content( const rtl::OUString& rURL,
const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XCommandEnvironment >& rEnv )
throw ( ::com::sun::star::ucb::ContentCreationException,
::com::sun::star::uno::RuntimeException );
/**
* Constructor.
*
* @param rId is the content identifier of the content to create.
* @param rEnv is the environment to use for commands executed by the
* content. The command environment is used by the content
* implementation to interact with the client and to propagate
* errors.
*/
Content( const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XContentIdentifier >& rId,
const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XCommandEnvironment >& rEnv )
throw ( ::com::sun::star::ucb::ContentCreationException,
::com::sun::star::uno::RuntimeException );
/**
* Constructor.
*
* @param rContent is the content object of the content to create.
* @param rEnv is the environment to use for commands executed by the
* content. The command environment is used by the content
* implementation to interact with the client and to propagate
* errors.
*/
Content( const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XContent >& rContent,
const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XCommandEnvironment >& rEnv )
throw ( ::com::sun::star::ucb::ContentCreationException,
::com::sun::star::uno::RuntimeException );
/**
* Copy Constructor.
*
* @param rContent is the content this content shall be a copy of.
*/
Content( const Content& rOther );
/**
* Destructor.
*/
~Content();
/**
* Assignment operator.
*
* @param rContent is the content this content shall be a copy of.
*/
Content& operator=( const Content& rOther );
/**
* Constructor. This method should be used, if the exception thrown
* by the direct ctors of this class are to 'expensive' for your
* application
*
* @param rURL is the URL of the content to create.
* @param rEnv is the environment to use for commands executed by the
* content. The command environment is used by the content
* implementation to interact with the client and to propagate
* errors.
* @param rContent will be filled by this method with the content created.
* @return true, if the operation was successful - false, otherwise.
*/
static sal_Bool
create( const rtl::OUString& rURL,
const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XCommandEnvironment >& rEnv,
Content& rContent );
/**
* Constructor. This method should be used, if the exception thrown
* by the direct ctors of this class are to 'expensive' for your
* application
*
* @param rId is the content identifier of the content to create.
* @param rEnv is the environment to use for commands executed by the
* content. The command environment is used by the content
* implementation to interact with the client and to propagate
* errors.
* @param rContent will be filled by this method with the content created.
* @return true, if the operation was successful - false, otherwise.
*/
static sal_Bool
create( const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XContentIdentifier >& rId,
const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XCommandEnvironment >& rEnv,
Content& rContent );
/**
* Constructor. This method should be used, if the exception thrown
* by the direct ctors of this class are to 'expensive' for your
* application
*
* @param xContent is the content object of the content to create.
* @param rEnv is the environment to use for commands executed by the
* content. The command environment is used by the content
* implementation to interact with the client and to propagate
* errors.
* @param rContent will be filled by this method with the content created.
* @return true, if the operation was successful - false, otherwise.
*/
static sal_Bool
create( const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XContent >& xContent,
const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XCommandEnvironment >& rEnv,
Content& rContent );
//////////////////////////////////////////////////////////////////////
// Direct access to UCB content.
//////////////////////////////////////////////////////////////////////
/**
* This method provides access to the "native" UCB content interface(s).
* This is usefull in case the convenience methods provided by this
* class are insufficient for your needs. You may obtain all interfaces
* supported by the underlying UCB content by calling this method and
* after that doing a queryInterface call.
*
* @return the XContent interface of the underlying UCB content.
*/
::com::sun::star::uno::Reference< ::com::sun::star::ucb::XContent >
get() const;
//////////////////////////////////////////////////////////////////////
// Object identity.
//////////////////////////////////////////////////////////////////////
/**
* This method returns the URL of the content.
*
* @return the URL of the content.
*/
const ::rtl::OUString& getURL() const;
//////////////////////////////////////////////////////////////////////
// Command environment.
//////////////////////////////////////////////////////////////////////
/**
* This method returns the environment to use when executing commands.
*
* @return the command environment.
*/
const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XCommandEnvironment >&
getCommandEnvironment() const;
/**
* This method sets a new command environment.
*
* @param xNewEnv is the new command environment.
*/
void setCommandEnvironment(
const ::com::sun::star::uno::Reference<
::com::sun::star::ucb::XCommandEnvironment >& xNewEnv );
//////////////////////////////////////////////////////////////////////
// Access to supported commands/properties.
//////////////////////////////////////////////////////////////////////
/**
* This methods provides access to meta data of the commands supported
* by this content.
*
* @return an XCommandInfo interface implementation, which can be used
* to obtain meta data of the commands supported by this content.
*/
::com::sun::star::uno::Reference< ::com::sun::star::ucb::XCommandInfo >
getCommands()
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This methods provides access to meta data of the properties supported
* by this content.
*
* @return an XPropertSetInfo interface implementation, which can be used
* to obtain meta data of the properties supported by this content.
*/
::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySetInfo >
getProperties()
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
//////////////////////////////////////////////////////////////////////
// Access to property value(s).
//////////////////////////////////////////////////////////////////////
/**
* This method can be used to read a single property value.
*
* @param rPropertyName is the name of the property for that the value
* shall be obtained.
* @return the property value.
*/
::com::sun::star::uno::Any
getPropertyValue( const rtl::OUString& rPropertyName )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method can be used to read a single property value.
*
* @param nPropertyHande is the handle of the property for that the
* value shall be obtained.
* @return the property value.
*/
::com::sun::star::uno::Any
getPropertyValue( sal_Int32 nPropertyHandle )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method can be used to set a single property value.
*
* @param rPropertyName is the name of the property for that the
* value shall be set.
* @return an any containing:
* - No value indicates, that the property value was set
* successfully.
* - com::sun::star::beans::UnknownPropertyException indicates,
* that the property is not known to the content implementation.
* - com::sun::star::beans::IllegalTypeException indicates, that
* the data type of the property value is not acceptable.
* - com::sun::star::lang::IllegalAccessException indicates, that
* the property is constant.
* - com::sun::star::lang::IllegalArgumentException indicates,
* that the property value is not acceptable. For instance,
* setting an empty title may be illegal.
* - Any other execption derived from
* com::sun::star::uno::Exception indicates, that the value was
* not set successfully. For example, this can be a
* com::sun:star::ucb::InteractiveAugmentedIOException
* transporting the error code
* com::sun::star::ucb::IOErrorCode::ACCESS_DENIED.
*/
::com::sun::star::uno::Any
setPropertyValue( const rtl::OUString& rPropertyName,
const ::com::sun::star::uno::Any& rValue )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method can be used to set a single property value.
*
* @param nPropertyHande is the handle of the property for that the
* value shall be set.
* @return an any containing:
* - No value indicates, that the property value was set
* successfully.
* - com::sun::star::beans::UnknownPropertyException indicates,
* that the property is not known to the content implementation.
* - com::sun::star::beans::IllegalTypeException indicates, that
* the data type of the property value is not acceptable.
* - com::sun::star::lang::IllegalAccessException indicates, that
* the property is constant.
* - com::sun::star::lang::IllegalArgumentException indicates,
* that the property value is not acceptable. For instance,
* setting an empty title may be illegal.
* - Any other execption derived from
* com::sun::star::uno::Exception indicates, that the value was
* not set successfully. For example, this can be a
* com::sun:star::ucb::InteractiveAugmentedIOException
* transporting the error code
* com::sun::star::ucb::IOErrorCode::ACCESS_DENIED.
*/
::com::sun::star::uno::Any
setPropertyValue( const sal_Int32 nPropertyHandle,
const ::com::sun::star::uno::Any& rValue )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method can be used to read multiple property values.
*
* @param rPropertyNames is a sequence of names of properties for
* that the values shall be obtained.
* @return the property values.
*/
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >
getPropertyValues( const ::com::sun::star::uno::Sequence<
rtl::OUString >& rPropertyNames )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method can be used to read multiple property values.
*
* @param nPropertyHandles is a sequence of handles of properties for
* that the values shall be obtained.
* @return an XRow interface that can be used to obtain the property
* values.
*/
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >
getPropertyValues( const ::com::sun::star::uno::Sequence<
sal_Int32 >& nPropertyHandles )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method can be used to read multiple property values.
*
* @param rPropertyNames is a sequence of names of properties for
* that the values shall be obtained.
* @return the property values.
*/
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRow >
getPropertyValuesInterface( const ::com::sun::star::uno::Sequence<
rtl::OUString >& rPropertyNames )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method can be used to read multiple property values.
*
* @param nPropertyHandles is a sequence of handles of properties for
* that the values shall be obtained.
* @return an XRow interface that can be used to obtain the property
* values.
*/
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XRow >
getPropertyValuesInterface( const ::com::sun::star::uno::Sequence<
sal_Int32 >& nPropertyHandles )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method can be used to set multiple property values.
*
* @param rPropertyNames is a sequence of names of properties for
* that values shall be set.
* @return a sequence of any's which has exactly the same number
* of elements as the number of properties to set. Every
* sequence element contains the status for a property. The
* first sequence elements corresponds to the first element in
* the sequence of property names and so on.
*
* An any containing:
* - No value indicates, that the property value was set
* successfully.
* - com::sun::star::beans::UnknownPropertyException indicates,
* that the property is not known to the content implementation.
* - com::sun::star::beans::IllegalTypeException indicates, that
* the data type of the property value is not acceptable.
* - com::sun::star::lang::IllegalAccessException indicates, that
* the property is constant.
* - com::sun::star::lang::IllegalArgumentException indicates,
* that the property value is not acceptable. For instance,
* setting an empty title may be illegal.
* - Any other execption derived from
* com::sun::star::uno::Exception indicates, that the value was
* not set successfully. For example, this can be a
* com::sun:star::ucb::InteractiveAugmentedIOException
* transporting the error code
* com::sun::star::ucb::IOErrorCode::ACCESS_DENIED.
*/
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >
setPropertyValues( const ::com::sun::star::uno::Sequence<
rtl::OUString >& rPropertyNames,
const ::com::sun::star::uno::Sequence<
::com::sun::star::uno::Any >& rValues )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method can be used to set multiple property values.
*
* @param nPropertyHandles is a sequence of handles of properties for
* that values shall be set.
* @return a sequence of any's which has exactly the same number
* of elements as the number of properties to set. Every
* sequence element contains the status for a property. The
* first sequence elements corresponds to the first element in
* the sequence of property names and so on.
*
* An any containing:
* - No value indicates, that the property value was set
* successfully.
* - com::sun::star::beans::UnknownPropertyException indicates,
* that the property is not known to the content implementation.
* - com::sun::star::beans::IllegalTypeException indicates, that
* the data type of the property value is not acceptable.
* - com::sun::star::lang::IllegalAccessException indicates, that
* the property is constant.
* - com::sun::star::lang::IllegalArgumentException indicates,
* that the property value is not acceptable. For instance,
* setting an empty title may be illegal.
* - Any other execption derived from
* com::sun::star::uno::Exception indicates, that the value was
* not set successfully. For example, this can be a
* com::sun:star::ucb::InteractiveAugmentedIOException
* transporting the error code
* com::sun::star::ucb::IOErrorCode::ACCESS_DENIED.
*/
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >
setPropertyValues( const ::com::sun::star::uno::Sequence<
sal_Int32 >& nPropertyHandles,
const ::com::sun::star::uno::Sequence<
::com::sun::star::uno::Any >& rValues )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
//////////////////////////////////////////////////////////////////////
// General command execution.
//////////////////////////////////////////////////////////////////////
/**
* This method can be used to execute any command supported by the
* content.
*
* @param rCommandName is the name of the command to execute.
* @param rCommandArgument is the argument for the command. Type and
* values of this parameter must correspond to the command
* specification.
* @return the result of the command according to its specification.
*/
::com::sun::star::uno::Any
executeCommand( const rtl::OUString& rCommandName,
const ::com::sun::star::uno::Any& rCommandArgument )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
::com::sun::star::uno::Any
/**
* This method can be used to execute any command supported by the
* content.
*
* @param rCommandHandle is the handle of the command to execute.
* @param rCommandArgument is the argument for the command. Type and
* values of this parameter must correspond to the command
* specification.
* @return the result of the command according to its specification.
*/
executeCommand( sal_Int32 nCommandHandle,
const ::com::sun::star::uno::Any& rCommandArgument )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method can be used to abort the command currently executed by
* a content. Note that a content can only process one command per
* thread at a time. The implementation of the content is responsible
* for determining the command to abort when this method is called.
*/
void
abortCommand();
//////////////////////////////////////////////////////////////////////
// Special commands.
//////////////////////////////////////////////////////////////////////
/**
* This methods gives access to the children of a folder content.
* Additionally, the result set returned provides efficient access to
* preselected property values of the children.
* Internally it executes the command "open" at the content.
*
* @param rPropertyNames is a sequence of names of properties for
* that the values should be accessible via the resultset
* returned by this method.
* @param eMode is a very simple filter for the children contained
* in the resultset.
* @return an implementation of the service
* com.cun.star.ucb.ContentResultSet, which can be used to
* get access to the children of a content.
*/
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >
createCursor( const ::com::sun::star::uno::Sequence<
rtl::OUString >& rPropertyNames,
ResultSetInclude eMode = INCLUDE_FOLDERS_AND_DOCUMENTS )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This methods gives access to the children of a folder content.
* Additionally, the result set returned provides efficient access to
* preselected property values of the children.
* Internally it executes the command "open" at the content.
*
* @param nPropertyHandles is a sequence of handles of properties for
* that the values should be accessible via the resultset
* returned by this method.
* @param eMode is a very simple filter for the children contained
* in the resultset.
* @return an implementation of the service
* com.cun.star.ucb.ContentResultSet, which can be used to
* get access to the children of a content.
*/
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >
createCursor( const ::com::sun::star::uno::Sequence<
sal_Int32 >& rPropertyHandles,
ResultSetInclude eMode = INCLUDE_FOLDERS_AND_DOCUMENTS )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This methods gives access to the children of a folder content.
* Additionally, the result set returned provides efficient access to
* preselected property values of the children.
* Internally it executes the command "open" at the content.
*
* @param rPropertyNames is a sequence of names of properties for
* that the values should be accessible via the resultset
* returned by this method.
* @param eMode is a very simple filter for the children contained
* in the resultset.
* @return an implementation of the service
* com.cun.star.ucb.DynamicResultSet, which can be used to
* get access to the children of a content.
*/
::com::sun::star::uno::Reference< ::com::sun::star::ucb::XDynamicResultSet >
createDynamicCursor( const ::com::sun::star::uno::Sequence<
rtl::OUString >& rPropertyNames,
ResultSetInclude eMode
= INCLUDE_FOLDERS_AND_DOCUMENTS )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This methods gives access to the children of a folder content.
* Additionally, the result set returned provides efficient access to
* preselected property values of the children.
* Internally it executes the command "open" at the content.
*
* @param nPropertyHandes is a sequence of handles of properties for
* that the values should be accessible via the resultset
* returned by this method.
* @param eMode is a very simple filter for the children contained
* in the resultset.
* @return an implementation of the service
* com.cun.star.ucb.DynamicResultSet, which can be used to
* get access to the children of a content.
*/
::com::sun::star::uno::Reference< ::com::sun::star::ucb::XDynamicResultSet >
createDynamicCursor( const ::com::sun::star::uno::Sequence<
sal_Int32 >& rPropertyHandles,
ResultSetInclude eMode
= INCLUDE_FOLDERS_AND_DOCUMENTS )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
::com::sun::star::uno::Reference< ::com::sun::star::ucb::XDynamicResultSet >
createSortedDynamicCursor( const ::com::sun::star::uno::Sequence< rtl::OUString >& rPropertyNames,
const ::com::sun::star::uno::Sequence< ::com::sun::star::ucb::NumberedSortingInfo >& rSortInfo,
::com::sun::star::uno::Reference< ::com::sun::star::ucb::XAnyCompareFactory > rAnyCompareFactory,
ResultSetInclude eMode = INCLUDE_FOLDERS_AND_DOCUMENTS )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
::com::sun::star::uno::Reference< ::com::sun::star::ucb::XDynamicResultSet >
createSortedDynamicCursor( const ::com::sun::star::uno::Sequence< sal_Int32 >& rPropertyHandles,
const ::com::sun::star::uno::Sequence< ::com::sun::star::ucb::NumberedSortingInfo >& rSortInfo,
::com::sun::star::uno::Reference< ::com::sun::star::ucb::XAnyCompareFactory > rAnyCompareFactory,
ResultSetInclude eMode = INCLUDE_FOLDERS_AND_DOCUMENTS )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >
createSortedCursor( const ::com::sun::star::uno::Sequence< rtl::OUString >& rPropertyNames,
const ::com::sun::star::uno::Sequence< ::com::sun::star::ucb::NumberedSortingInfo >& rSortInfo,
::com::sun::star::uno::Reference< ::com::sun::star::ucb::XAnyCompareFactory > rAnyCompareFactory,
ResultSetInclude eMode = INCLUDE_FOLDERS_AND_DOCUMENTS )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
::com::sun::star::uno::Reference< ::com::sun::star::sdbc::XResultSet >
createSortedCursor( const ::com::sun::star::uno::Sequence< sal_Int32 >& rPropertyHandles,
const ::com::sun::star::uno::Sequence< ::com::sun::star::ucb::NumberedSortingInfo >& rSortInfo,
::com::sun::star::uno::Reference< ::com::sun::star::ucb::XAnyCompareFactory > rAnyCompareFactory,
ResultSetInclude eMode = INCLUDE_FOLDERS_AND_DOCUMENTS )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This methods gives read access to the content stream of a content (i.e
* the content of a file located at the local file system).
* Internally it executes the command "open" at the content.
*
* @return an implementation of the interface XInputStream, which can
* be used to read the content's data.
*/
::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >
openStream()
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This methods gives read access to the content stream of a content (i.e
* the content of a file located at the local file system).
* Internally it executes the command "open" at the content.
* The method requests opening without locking.
*
* @return an implementation of the interface XInputStream, which can
* be used to read the content's data.
*/
::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >
openStreamNoLock()
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This methods gives read/write access to the content stream of a content (i.e
* the content of a file located at the local file system).
* Internally it executes the command "open" at the content.
*
* @return an implementation of the interface XStream, which can
* be used to read/write the content's data.
*/
::com::sun::star::uno::Reference< ::com::sun::star::io::XStream >
openWriteableStream()
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This methods gives read/write access to the content stream of a content (i.e
* the content of a file located at the local file system).
* Internally it executes the command "open" at the content.
* The method requests opening without locking.
*
* @return an implementation of the interface XStream, which can
* be used to read/write the content's data.
*/
::com::sun::star::uno::Reference< ::com::sun::star::io::XStream >
openWriteableStreamNoLock()
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This methods gives read access to the content stream of a content (i.e
* the content of a file located at the local file system).
* Internally it executes the command "open" at the content.
*
* @param rSink is the implementation of an XActiveDataSink interface,
* which shall be used by the content to deliver the data.
*/
sal_Bool
openStream( const ::com::sun::star::uno::Reference<
::com::sun::star::io::XActiveDataSink >& rSink )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This methods gives read access to the content stream of a content (i.e
* the content of a file located at the local file system).
* Internally it executes the command "open" at the content.
*
* @param rStream is the implementation of an XOutputStream interface,
* which shall be used by the content to deliver the data.
*/
sal_Bool
openStream( const ::com::sun::star::uno::Reference<
::com::sun::star::io::XOutputStream >& rStream )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This methods gives write access to the content stream of a content (i.e
* the content of a file located at the local file system).
* Internally it executes the command "insert" at the content.
*
* @param rStream is the implementation of an XInputStream interface,
* which contains the content data to write.
* @param bReplaceExisting specifies, whether any existing content data
* shall be overwritten.
*/
void
writeStream( const ::com::sun::star::uno::Reference<
::com::sun::star::io::XInputStream >& rStream,
sal_Bool bReplaceExisting )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method returns the different types of contents this content
* can create.
*
* @return the content types or an empty sequence if no contents can be
* created by this content.
*/
::com::sun::star::uno::Sequence< ::com::sun::star::ucb::ContentInfo >
queryCreatableContentsInfo()
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method creates, initializes and inserts ( commits ) a new content
* (i.e. it could be used to create a new file system folder).
* Internally this method does a
* XCommandProcessor::execute( "createNewContent", ... );
* XCommandProcessor::execute( "setPropertyValues", ... );
* XCommandProcessor::execute( "insert", ... ); calling sequence.
*
* @param rContentType is the type for the new UCB content. Each content
* provider implementation may introduce own types for its content
* objects (See queryCreatableContentsInfo()).
* @param rPropertyNames is a sequence of names of properties for that
* values are to set at the new content before it will be inserted
* ( commited ).
* The order of the names must correspond to the order of the
* property values.
* @param rPropertyValues is a sequence of property values that are to
* set at the new content before it will be inserted ( commited ).
* The order of the values must correspond to the order of the
* property names.
* @param rNewContent will be filled by the implementation of this method
* with the new content.
*/
sal_Bool
insertNewContent( const ::rtl::OUString& rContentType,
const ::com::sun::star::uno::Sequence<
rtl::OUString >& rPropertyNames,
const ::com::sun::star::uno::Sequence<
::com::sun::star::uno::Any >& rPropertyValues,
Content& rNewContent )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method creates, initializes and inserts ( commits ) a new content
* (i.e. it could be used to create a new file system folder).
* Internally this method does a
* XCommandProcessor::execute( "createNewContent", ... );
* XCommandProcessor::execute( "setPropertyValues", ... );
* XCommandProcessor::execute( "insert", ... ); calling sequence.
*
* @param rContentType is the type for the new UCB content. Each content
* provider implementation may introduce own types for its content
* objects (See queryCreatableContentsInfo()).
* @param nPropertyHandes is a sequence of handles of properties for that
* values are to set at the new content before it will be inserted
* ( commited ).
* The order of the handles must correspond to the order of the
* property values.
* @param rPropertyValues is a sequence of property values that are to
* set at the new content before it will be inserted ( commited ).
* The order of the values must correspond to the order of the
* property handles.
* @param rNewContent will be filled by the implementation of this method
* with the new content.
*/
sal_Bool
insertNewContent( const ::rtl::OUString& rContentType,
const ::com::sun::star::uno::Sequence<
sal_Int32 >& nPropertyHandles,
const ::com::sun::star::uno::Sequence<
::com::sun::star::uno::Any >& rPropertyValues,
Content& rNewContent )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method creates, initializes and inserts (commits) a new content
* inside this (the target folder) content. For example, it can be used to
* create a new file system file.
* Internally this method does a
* XCommandProcessor::execute( "createNewContent", ... );
* XCommandProcessor::execute( "setPropertyValues", ... );
* XCommandProcessor::execute( "insert", ... ); calling sequence.
*
* @param rContentType is the type for the new UCB content. Each content
* provider implementation may introduce own types for its content
* objects (See queryCreatableContentsInfo()).
* @param rPropertyNames is a sequence of names of properties for that
* values are to set at the new content before it will be inserted
* ( commited ).
* The order of the names must correspond to the order of the
* property values.
* @param rPropertyValues is a sequence of property values that are to
* set at the new content before it will be inserted ( commited ).
* The order of the values must correspond to the order of the
* property names.
* @param rStream is a stream containing the content data for the new
* content (i.e. the content of a file to create)
* @param rNewContent will be filled by the implementation of this method
* with the new content.
*/
sal_Bool
insertNewContent( const ::rtl::OUString& rContentType,
const ::com::sun::star::uno::Sequence<
rtl::OUString >& rPropertyNames,
const ::com::sun::star::uno::Sequence<
::com::sun::star::uno::Any >& rPropertyValues,
const ::com::sun::star::uno::Reference<
::com::sun::star::io::XInputStream >& rStream,
Content& rNewContent )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method creates, initializes and inserts (commits) a new content
* inside this (the target folder) content. For example, it can be used to
* create a new file system file.
* Internally this method does a
* XCommandProcessor::execute( "createNewContent", ... );
* XCommandProcessor::execute( "setPropertyValues", ... );
* XCommandProcessor::execute( "insert", ... ); calling sequence.
*
* @param rContentType is the type for the new UCB content. Each content
* provider implementation may introduce own types for its content
* objects (See queryCreatableContentsInfo()).
* @param nPropertyHandes is a sequence of handles of properties for that
* values are to set at the new content before it will be inserted
* ( commited ).
* The order of the handles must correspond to the order of the
* property values.
* @param rPropertyValues is a sequence of property values that are to
* set at the new content before it will be inserted ( commited ).
* The order of the values must correspond to the order of the
* property handles.
* @param rStream is a stream containing the content data for the new
* content (i.e. the content of a file to create)
* @param rNewContent will be filled by the implementation of this method
* with the new content.
*/
sal_Bool
insertNewContent( const ::rtl::OUString& rContentType,
const ::com::sun::star::uno::Sequence<
sal_Int32 >& nPropertyHandles,
const ::com::sun::star::uno::Sequence<
::com::sun::star::uno::Any >& rPropertyValues,
const ::com::sun::star::uno::Reference<
::com::sun::star::io::XInputStream >& rStream,
Content& rNewContent )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method transfers (copies/moves) a content. It creates a new
* resource inside this (the target folder) content.
* The implementation is able to do cross-provider transfers (like copying
* a file from the local file system to a directory located on an HTTP
* server).
* Internally this method executes the command "globalTransfer" at the UCB.
*
* @param rSourceContent is the content that contains the data for the
* new UCB content.
* @param eOperation defines what shall be done with the source data
* ( COPY, MOVE, LINK ).
* @param rTitle contains a title for the new content. If this is an empty
* string, the new content will have the same title as the source
* content.
* @param rNameClashAction describes how the implementation shall behave
* in case a content with a clashing name exists in the target
* folder.
* NameClash::ERROR will abort the operation, NameClash::OVERWRITE
* will overwrite the clashing content and all its data,
* NameClash::RENAME will generate and supply a non-clashing title.
* @see com/sun/star/ucb/NameClash.idl
*/
sal_Bool
transferContent( const Content& rSourceContent,
InsertOperation eOperation,
const ::rtl::OUString & rTitle,
const sal_Int32 nNameClashAction )
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
//////////////////////////////////////////////////////////////////////
// Required properties.
//////////////////////////////////////////////////////////////////////
/**
* This method returns the value of the content's property "IsFolder".
*
* @return true, if the content is a folder ( it can contain other
* UCB contents). false, otherwise.
*/
sal_Bool
isFolder()
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
/**
* This method returns the value of the content's property "IsDocument".
*
* @return true, if the content is a document ( it has a content stream ).
* false, otherwise.
*/
sal_Bool
isDocument()
throw( ::com::sun::star::ucb::CommandAbortedException,
::com::sun::star::uno::RuntimeException,
::com::sun::star::uno::Exception );
};
} /* namespace ucbhelper */
#endif /* !_UCBHELPER_CONTENT_HXX */
|
