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