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