xref: /trunk/main/offapi/com/sun/star/ucb/Content.idl (revision e5886c2d)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_ucb_Content_idl__
29#define __com_sun_star_ucb_Content_idl__
30
31#include <com/sun/star/ucb/XContent.idl>
32#include <com/sun/star/ucb/XContent.idl>
33#include <com/sun/star/lang/XComponent.idl>
34#include <com/sun/star/ucb/XCommandProcessor.idl>
35#include <com/sun/star/ucb/XCommandProcessor2.idl>
36#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
37#include <com/sun/star/beans/XPropertyContainer.idl>
38#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
39#include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
40#include <com/sun/star/ucb/XContentCreator.idl>
41#include <com/sun/star/container/XChild.idl>
42
43//=============================================================================
44
45module com { module sun { module star { module ucb {
46
47//=============================================================================
48/** A <type>Content</type> is a service that provides access to data of a
49    content provided by an implementation of the service
50    <type>ContentProvider</type>.
51*/
52published service Content
53{
54    //-------------------------------------------------------------------------
55    /** provides access to the identitity and the type of the content and
56        allows the registration of listeners for <type>ContentEvent</type>s.
57
58        <p>This interface is required.
59     */
60    interface com::sun::star::ucb::XContent;
61
62    //-------------------------------------------------------------------------
63    /** must be implemented to make it possible to resolve cyclic object
64        references.
65
66        <p>Those references i.e. may occure if there are listeners
67        registered at the content ( the content holds the listeners ) and
68        the implementation of the listener interface holds a reference on
69        the content. If the content shall be released,
70        <member scope="com::sun::star::lang">XComponent::dispose</member> must
71        be called at the content. The implementation of this method must call
72        <member scope="com::sun::star::lang">XEventListener::disposing</member>
73        on the registered listeners and release the appropriate object
74        references. At the other hand, the implementation of
75        XEventListener::disposing must release its appropriate references.
76
77        <p>This interface is required.
78     */
79    interface com::sun::star::lang::XComponent;
80
81    //-------------------------------------------------------------------------
82    /** enables the caller to let the content execute commands.
83
84        <p>It is strongly recommended that any implementation supports the
85        improved <type>XCommandProcessor2</type> interface.</p>
86
87        <p>Typical commands are "open", "delete", "getPropertyValues" and
88        "setPropertyValues". Each content must support a set of standard
89        commands and properties. Also there is a set of predefined optionally
90        commands and properties. A content may define additional commands and
91        properties. </p>
92
93        <p>This interface is required. </p>
94
95        <pre>
96        =======================================================================
97        Commands:
98        =======================================================================
99
100        [return type]
101            [command name]
102                [parameter type and name]
103
104        -----------------------------------------------------------------------
105        Mandatory commands:
106        -----------------------------------------------------------------------
107
108        // This command obtains an interface which allows to query
109        // information on commands supported by a content.
110        <type>XCommandInfo</type>
111            getCommandInfo
112                void
113
114        // This command obtains an interface which allows to query
115        // information on properties supported by a content.
116        <type scope="com::sun::star::beans">XPropertySetInfo</type>
117            getPropertySetInfo
118                void
119
120        // This command obtains property values from the content.
121        // Note: The execution will not be aborted, if there are properties
122        //       requested, that are unknown to the content! The returned
123        //       row object must contain a NULL value in the corresponding
124        //       column instead.
125        <type scope="com::sun::star::sdbc">XRow</type>
126            getPropertyValues
127                sequence&lt; <type scope="com::sun::star::beans">Property</type> &gt; aProps
128
129        // This command sets property values of the content.
130        // Note that setPropertyValues does not throw an exception in the case
131        // that one or more of the requested property values cannot be set! The
132        // implementation should set as much property values as possible. This
133        // command returns a sequence< any > which has exactly the same number
134        // of elements like the number of properties to set. Every sequence
135        // element contains the status for a property. The first sequence
136        // elements corresponds to the first element in the sequence of
137        // <type scope="com::sun::star::beans">PropertyValue</type> passed as
138        // command argument and so on. The exceptions will never be passed to
139        // an Interaction Handler.
140        //
141        // An any containing:
142        //
143        // - No value indicates, that the property value was set successfully.
144        // - <type scope="com::sun::star::beans">UnknownPropertyException</type>
145        //   indicates, that the property is not known to the content
146        //   implementation.
147        // - <type scope="com::sun::star::beans">IllegalTypeException</type>
148        //   indicates, that the data type of the property value is not
149        //   acceptable.
150        // - <type scope="com::sun::star::lang">IllegalAccessException</type>
151        //   indicates, that the property is constant
152        //   (<member scope="com::sun::star::beans">PropertyAttribute::READONLY</member>
153        //   is set).
154        // - <type scope="com::sun::star::lang">IllegalArgumentException</type>
155        //   indicates, that the property value is not acceptable. For instance,
156        //   setting an empty title may be illegal.
157        // - Any other execption derived from <type scope="com::sun::star::uno">Exception</type>
158        //   indicates, that the value was not set successfully. For example,
159        //   this can be a <type>InteractiveAugmentedIOException</type>
160        //   transporting the error code <member>IOErrorCode::ACCESS_DENIED</member>.
161        //
162        // If the value to set is equal to the current value, no exception must
163        // be added to the returned sequence
164        sequence&lt; any &gt;
165            setPropertyValues
166                sequence&lt; <type scope="com::sun::star::beans">PropertyValue</type> &gt; aValues
167
168        -----------------------------------------------------------------------
169        Optional commands:
170        -----------------------------------------------------------------------
171
172        // For folder objects, this command will return an implementation
173        // of service <type>DynamicResultSet</type>.
174        //
175        // The <type>OpenCommandArgument2</type> members must be filled as follows:
176        //
177        // Mode         : ALL or FOLDERS or DOCUMENTS. The implementation
178        //                of the open command MUST support all these modes!
179        // Priority     : can be set, but implementation may ignore the value
180        // Sink         : empty( ignored )
181        // Properties   : The properties for that the result set shall
182        //                contain the property values. The order of the
183        //                sequence is the same as the order of result set
184        //                columns. First element of sequence will be row
185        //                number one, second will be row number two, ...
186        // SortingInfo      : contains sort criteria, if result set shall
187        //                be sorted, otherwise it can be left empty.
188        //
189        // The exceution must be aborted by the implementation of this command
190        // (by throwing a <type>CommandAbortedException</type>), if an
191        // unsupported mode is requested.
192        <type>XDynamicResultSet</type>
193            <B>open</B>
194                <type>OpenCommandArgument2</type> aOpenCommandArg
195
196        // For non-folder objects, the <type>OpenCommandArgument2</type> struct
197        // will be prefilled with a data sink object, which will be filled
198        // with the content data.
199        //
200        // The <type>OpenCommandArgument2</type> members must be filled as follows:
201        //
202        // Mode         : DOCUMENT or DOCUMENT_SHARE_DENY_NONE or
203        //                DOCUMENT_SHARE_DENY_WRITE. Support for DOCUMENT
204        //                is mandatory, all others are optional.
205        // Priority     : can be set, but implementation may ignore the value
206        // Sink         : a sink, where the implementation can put the
207        //                document data into.
208        // Properties   : empty ( ignored )
209        // SortingInfo      : empty ( ignored )
210        //
211        // The exceution must be aborted by the implementation of this command
212        // (by throwing a <type>CommandAbortedException</type>), if an
213        // unsupported mode is requested.
214        void
215            <B>open</B>
216                <type>OpenCommandArgument2</type> aOpenCommandArg
217
218        // This command triggers an update operation on a content. For example,
219        // when "updating" a POP3-Inbox, the content for that box will get
220        // and store all new objects on the appropriate server. The inserted
221        // contents will be notified by calling
222        // <member>XContentEventListener::contentEvent</member>.
223        void
224            <B>update</B>
225                <type>OpenCommandArgument2</type> aOpenCommandArg
226
227        // This command triggers a synchronization operation between locally
228        // cached data and remote server's data. For example, when
229        // "synchronizing" a POP3-Inbox the content for that box will get and
230        // store all new objects and destroy all cached data for objects no
231        // longer existing on the server. The inserted/deleted contents will
232        // be notified by calling
233        // <member>XContent::contentEvent</member>.
234        void
235            <B>synchronize</B>
236                <type>OpenCommandArgument2</type> aOpenCommandArg
237
238        // This command closes an object.
239        void
240            <B>close</B>
241                void
242
243        // This command deletes an object. If <TRUE/> is passed as parameter,
244        // the object will be destroyed physically. Otherwise it will be put
245        // into trash can, if such a service is available and the object to
246        // be deleted supports the command "undelete".
247        // On successful completion of this command, the deleted content
248        // must propagate its deletion by notifying a <type>ContentEvent</type>
249        // - <member>ContentAction::DELETED</member>. Additionally, the contents
250        // parent must notify a <type>ContentEvent</type>
251        // - <member>ContentAction::REMOVED</member>
252        void
253            <B>delete</B>
254                boolean bDeletePhysically
255
256        // This command restores an object previously deleted into trash. It
257        // must be supported by objects which claim to be undeletable, but
258        // should never be called directly.
259        void
260            <B>undelete</B>
261                void
262
263        // (1) This command inserts a new content. It commits the process of
264        // creating a new content via executing the command "createNewContent"
265        // and initializing it via setting properties, afterwards.
266        // The command is not called on the content which created the new
267        // content, because the new object already knows where it is to be
268        // inserted (i.e. Calling createNewContent with the content type for a
269        // message on a News Group creates a content which internally belongs
270        // to the Outbox. Calling "insert" on that message will result in
271        // posting the article to the appropriate News Group). Not calling
272        // "insert" for the new content, i.e. because the user cancels writing
273        // a new message, simply discards the new object. No extra call to
274        // "delete" is necessary.
275        // On successful completion of this command, the parent of the inserted
276        // content must propagate the change by notifying a
277        // <type>ContentEvent</type> - <member>ContentAction::INSERTED</member>.
278        //
279        // (2) Additionally this command can be called at any time to overwrite
280        // the data of an existing content.
281        void
282            <B>insert</B>
283                <type>InsertCommandArgument</type> aInsertCommandArg
284
285        // This command searches for subcontents of a content matching the
286        // given search criteria. The command will return an implemenation
287        // of service <type>DynamicResultSet</type>.
288        <type>XDynamicResultSet</type>
289            <B>search</B>
290                <type>SearchCommandArgument</type> aSearchCommandArg
291
292        // <b>Important note:</b> A client that wants to transfer data should
293        // not execute this command, but it should execute the command
294        // "globalTransfer" at the <type>UniversalContentBroker</type>.
295        // This command is able to transfer all kind of content
296        // supported by that UCB.
297        //
298        // This command transfers (copies/moves) an object from one location
299        // to another. It must be executed at the folder content representing
300        // the destination of the transfer operation. Note that the
301        // implementation need not(!) be able to handle any type of contents.
302        // Generally, there are good chances that a transfer of a content will
303        // succeed, if source and target folder have the same URL scheme.
304        // But there is no guaranty for that. For instance, moving a message
305        // from a folder on IMAP server A to a folder on IMAP server B may
306        // fail, because the transfer command can't be implemented efficiently
307        // for this scenario, because it is not directly supported by the IMAP
308        // protocol. On the other hand, moving a message from one folder to
309        // another folder on the same IMAP server should work, because it can
310        // be implemeted efficiently. If an implementation is not able to
311        // handle a given source URL, it should indicate this by issuing a
312        // <type>InteractiveBadTransferURLException</type> interaction request.
313        // Source and target folder may be the same when doing a move operation.
314        //
315        // Transfers without the transfer command can be done as follows:
316        //
317        // 1) Create a new content at the target folder
318        //    --> targetContent = target.execute( "createNewContent", type )
319        // 2) Transfer data from source to target content
320        //    --> props = sourceContent.execute( "getPropertyValues", ... )
321        //    --> dataStream = sourceContent.execute( "open", ... )
322        //    --> targetContent.execute( "setPropertyValues", props )
323        // 3) Insert ( commit ) the new content
324        //    --> targetContent.execute( "insert", dataStream )
325        // 4) For move operations only: destroy the source content
326        //    sourceContent.execute( "delete", ... )
327        //
328        // This mechanism should work for all transfer operations, but generally
329        // it's less efficient than the transfer command.
330        void
331            <B>transfer</B>
332                <type>TransferInfo</type> aTransferInfo
333
334        // This command obtains an exlusive write lock for the resource. The
335        // lock is active until command "unlock" is executed or the OOo
336        // session that obtained the lock ends or until the lock is released by
337        // a third party (e.g. a system administrator).
338        void
339            <B>lock</B>
340                void
341        Exceptions: <type>InteractiveLockingLockedException</type>
342                    <type>InteractiveLockingLockExpiredException</type>
343
344        // This command removes a lock obtained by executing the command "lock"
345        // from the resource.
346        void
347            <B>unlock</B>
348                void
349        Exceptions: <type>InteractiveLockingNotLockedException</type>
350                    <type>InteractiveLockingLockExpiredException</type>
351
352        // Note that <type>InteractiveLockingLockExpiredException</type> might
353        // be raised by any command that requires a previously obtained lock.
354
355        // This command creates a new non-persistent content of a given type.
356        //
357        // <p>Creation of a new (persistent) content:
358        // <ol>
359        //    <li>creatabletypes = obtain "CreatableContentsInfo" property<br>
360        //        from creator
361        //    <li>choose a suitable type from creatabletypes
362        //    <li>newObject = execute command "createNewContent(type)" at<br>
363        //        creator
364        //    <li>initialize the new object (i.e. newObject.Property1 = ...)
365        //    <li>execute command "insert" at new content. This command
366        //        commits the data and makes the new content persistent.
367        // </ol>
368        //
369        // This command must be supported by every Content that supports the
370        // property "CreatableContentsInfo" if the returned property value
371        // contains a non-empty sequence of creatable types.
372        //
373        // Note: This command is part of the replacement for the deprecated
374        // interface <type>XContentCreator</type>.
375        <type>XContent</type> >
376            <B>createNewContent</B>
377                <type>ContentInfo<type> contentinfo
378
379        =======================================================================
380        Properties:
381        =======================================================================
382
383        -----------------------------------------------------------------------
384        Mandatory properties:
385        -----------------------------------------------------------------------
386
387        // contains a unique(!) type string for the content ( i.e.
388        // "application/vnd.sun.star.hierarchy-link" ). This property is always
389        // read-only. It does not contain the media type ( MIME types ) of the
390        // content. Media types may be provided through the optional property
391        // "MediaType".
392        // The value of this property should match the information on creatable
393        // contents given by UCB contents that implement the property
394        // "CreatableContentsInfo".
395        string ContentType
396
397        // indicates, whether a content can contain other contents.
398        boolean IsFolder
399
400        // indicates, whether a content is a document. This means, the
401        // content can dump itself into a data sink.
402        boolean IsDocument
403
404        // contains the title of an object (e.g. the subject of a message).
405        string Title;
406
407        -----------------------------------------------------------------------
408        Optional properties:
409        -----------------------------------------------------------------------
410
411        // contains the interval for automatic updates of an object.
412        // It is specified in seconds.
413        long AutoUpdateInterval
414
415        // contains the maximum number of network connections
416        // allowed for one (internet) protocol at a time. (e.g. The HTTP
417        // cache can be configured to use a maximum for the number of
418        // connections used for browsing.)
419        short ConnectionLimit
420
421        // contains the current connection mode for the object.
422        // (see <type>ConnectionMode</type>)
423        short ConnectionMode
424
425        // contains the date and time the object was created.
426        <type scope"com::sun::star::util">DateTime</type> DateCreated
427
428        // contains the date and time the object was last modified.
429        <type scope"com::sun::star::util">DateTime</type> DateModified
430
431        // contains the count of documents of a folder.
432        long DocumentCount;
433
434        // contains the count of marked documents within a folder.
435        long DocumentCountMarked
436
437        // contains a sequence of documemt header fields (i.e. header
438        // fields of a MIME-message, or the document info of an
439        // office document ). For some standard header fields there
440        // are predefined separate properties, like &quot;MessageTo&quot;.
441        sequence&lt; <type>DocumentHeaderField</type> &gt; DocumentHeader
442
443        // contains information about the way a folder stores the
444        // contents of (remote) documents.
445        <type>DocumentStoreMode</type> DocumentStoreMode
446
447        // contains the count of subfolders of a folder.
448        long FolderCount
449
450        // contains the free space left on a storage device. It is
451            specified in bytes.
452        hyper FreeSpace
453
454        // indicates whether a content has subcontents, which are documents.
455        boolean HasDocuments
456
457        // indicates whether a content has subcontents, which are folders.
458        boolean HasFolders
459
460        // indicates whether a content is &quot;marked&quot;.
461        boolean IsMarked
462
463        // indicates whether a content has been "read".
464        boolean IsRead;
465
466        // indicates whether a content is read-only.
467        boolean IsReadOnly
468
469        // indicates whether a content is subscribed.
470        boolean IsSubscribed
471
472        // indicates whether the feature to store contents depending on
473        // their age is active.
474        boolean IsTimeLimitedStore;
475
476        // indicates whether (sub)contents shall be automatically updated
477        // everytime a (folder) content is opened. This property may be
478        // used to control whether a folder content should read data only
479        // from local cache when it is opened, or whether it should connect
480        // to a server to obtain latest data.
481        boolean UpdateOnOpen
482
483        // contains the keywords of a document (e.g. the value
484        // of the &quot;keywords&quot; header field of a news article).
485        string Keywords
486
487        // contains the media type ( MIME type ) of a content. It is highly
488        // recommended to support this property if the content's implementation
489        // can obtain the media type natively from its data source ( i.e.
490        // HTTP servers provide media types for all their documents ).
491        string MediaType
492
493        // contains the BCC (blind carbon copy) receiver(s) of a message.
494        string MessageBCC
495
496        // contains the CC (carbon copy) receiver(s) of a message.
497        string MessageCC
498
499        // contains (the address of) the sender of a message.
500        string MessageFrom
501
502        // contains the ID of a message.
503        string MessageId
504
505        // contains the &quot;In-Reply-To&quot; field of a message.
506        string MessageInReplyTo
507
508        // contains the &quot;Reply-To&quot; field of a message.
509        string MessageReplyTo
510
511        // contains the recipient(s) of a message.
512        string MessageTo
513
514        // contains the name(s) of the newsgroup(s) into which a message
515        // was posted.
516        string NewsGroups
517
518        // contains a password (e.g. needed to access a POP3-Server).
519        string Password
520
521        // contains a priority (i.e. of a message).
522        <type>Priority</type> Priority
523
524        // contains the &quot;References&quot; field of a news article.
525        string References
526
527        // contains the rules set for a content.
528        <type>RuleSet</type> Rules
529
530        // contains the count of seen/read subcontents of a folder content.
531        long SeenCount
532
533        // contains the base directory to use on a server. (e.g. Setting
534        // the server base of an FTP-Account to &quot;/pub/incoming&quot;
535        // will result in showing contents from that directory and not from
536        // server's root directory)
537        string ServerBase
538
539        // contains a server name (e.g. The name of the server to use for
540        // a POP3-Account).
541        string ServerName
542
543        // contains a numeric server port.
544        short ServerPort
545
546        // contains the size (usually in bytes) of an object.
547        hyper Size
548
549        // contains a size limit for an object. (e.g. One may specify the
550        // maximum size of the HTTP-Cache)
551        hyper SizeLimit
552
553        // contains the count of subscribed contents of a folder.
554        long SubscribedCount
555
556        // contains the policy to use when synchronizing two objects.
557        <type>SynchronizePolicy</type> SynchronizePolicy
558
559        // contains information about the target frame to use when displaying
560        // an object.
561
562        <p>The value is a string containing three tokens, separated by &quot;;&quot;
563        (A semicolon):<br/>
564        <dl>
565        <dt>1st token
566        </dt><dd>Behavior on &quot;select&quot; ( single click )
567        </dd><dt>2nd token
568        </dt><dd>Behavior on &quot;open&quot;   ( double click )
569        </dd><dt>3rd token
570        </dt><dd>Behavior on &quot;open in new task&quot; ( double click + CTRL key )
571        </dd></dl>
572        </p>
573        <p>  Each token may contain the following values:<br/>
574        <dl>
575        <dt>&quot;_beamer&quot;
576        </dt><dd>Show in &quot;Beamer&quot;
577        </dd><dt>&quot;_top&quot;
578        </dt><dd>Show in current frame (replaces old)
579        </dd><dt>&quot;_blank&quot;
580        </dt><dd>Show in new task
581        </dd></dl>
582        </p>
583        string TargetFrames
584
585        // for contents that are links to other contents, contains the URL of
586        // the target content
587        string TargetURL
588
589        // contains the value to use if the property "IsTimeLimitedStore" is set.
590        short TimeLimitStore;
591
592        // contains a user name. (e.g. the user name needed to access a
593        // POP3-Account)
594        string UserName
595
596        // describes a verification policy.
597        <type>VerificationMode</type> VerificationMode
598
599        // contains the types of Contents a Content object can create via
600        // command "createNewContent".
601        //
602        // If the property value can be a non-empty sequence, the Content must
603        // also support command "createNewContent".
604        //
605        // Note: This property is part of the replacement for the deprecated
606        // interface <type>XContentCreator</type>.
607        sequence <type>ContentInfo</type> CreatableContentsInfo
608
609        </pre>
610     */
611    interface com::sun::star::ucb::XCommandProcessor;
612
613    //-------------------------------------------------------------------------
614    /** is an enhanced version of <type>XCommandProcessor</type> that has an
615        additional method for releasing command identifiers obtained via
616        <member>XCommandProcessor::createCommandIdentifier</member> to avoid
617        resource leaks. For a detailed description of the problem refer to
618        <member>XCommandProcessor2::releaseCommandIdentifier</member>.
619
620        <p>Where many existing <type>Content</type> implementations do not
621        (yet), every new implementation should support this interface.
622     */
623    [optional] interface com::sun::star::ucb::XCommandProcessor2;
624
625    //-------------------------------------------------------------------------
626    /** notifies changes of property values to listeners registered for
627        those properties.
628
629        <p>This interface is required.
630     */
631    interface com::sun::star::beans::XPropertiesChangeNotifier;
632
633    //-------------------------------------------------------------------------
634    /** can be used to add new properties to the content and to remove
635        properties from the content dynamically.
636
637        <p>Note that the dynamic properties must be kept persistent. The
638        service <type>Store</type> (UCB persistence service) may be used to
639        implement this.
640
641        <p><b>Important:</b> The implementation of
642        <method scope="com::sun::star::beans">XPropertyContainer::addProperty</method>
643        must at least support adding properties of the following basic data
644        types:
645
646        <p>
647        <ul>
648        <li>boolean
649        <li>char
650        <li>byte
651        <li>string
652        <li>short
653        <li>long
654        <li>hyper
655        <li>float
656        <li>double
657        </ul>
658
659        <p>If a property with an unsupported type shall be added a
660        <type scope="com::sun::star::beans">IllegalTypeException</type> must
661        be raised.
662     */
663    interface com::sun::star::beans::XPropertyContainer;
664
665    //-------------------------------------------------------------------------
666    /** can be used to notify properties removed from or added to the
667        content's property set.
668
669        <p>This interface must be implemented, if the implementation can
670        dynamically change it's property set ( e.g. because it implements
671        the interface
672        <type scope="com::sun::star::beans">XPropertyContainer</type>. )
673     */
674    [optional] interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
675
676    //-------------------------------------------------------------------------
677    /** can be used to notify commands removed from or added to the
678        content's command set.
679
680        <p>This interface must be implemented, if the implementation can
681        dynamically change it's command set ( e.g. because the set of
682        available commands depends on the value of a property of the
683        content ).
684
685        <p>This interface is optional.
686     */
687    [optional] interface com::sun::star::ucb::XCommandInfoChangeNotifier;
688
689    //-------------------------------------------------------------------------
690    /** creates new contents (i.e. creates a new folder in another folder
691        somewhere in the local file system).
692
693        <p>A content is "new", if it does not physically exist before creating
694        it using this interface.
695
696        <p>This interface is optional. It should be implemented by contents
697        which shall be able to create new objects.
698
699        @deprecated
700
701        <p>This interface is <b>deprecated</b>. Use property
702        "CreatableContentsInfo" and command "createNewContent" instead.
703     */
704    [optional] interface com::sun::star::ucb::XContentCreator;
705
706    //-------------------------------------------------------------------------
707    /** provides access to the parent content of this content.
708
709        <p>The object returned by the implementation of the method
710        <member scope="com::sun::star::container">XChild::getParent()</member>
711        must implement the service <type>Content</type>. If the content is a
712        root object, an empty interface may be returned.
713
714        <p>This interface must be implemented by a content which is a (logical)
715        child of a content.
716     */
717    [optional] interface com::sun::star::container::XChild;
718};
719
720//=============================================================================
721
722}; }; }; };
723
724#endif
725