| blob | 316249427a742ad82fa904d9ed50b4e99fa79c7b |
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
22 /** A Content is a service that provides access to data of a
23 content provided by an implementation of the service
24 ContentProvider.
25 */
26 published service Content
27 {
29 /** provides access to the identity and the type of the content and
30 allows the registration of listeners for ContentEvents.
32 <p>This interface is required.
33 */
36 /** must be implemented to make it possible to resolve cyclic object
37 references.
39 <p>Those references i.e. may occur if there are listeners
40 registered at the content ( the content holds the listeners ) and
41 the implementation of the listener interface holds a reference on
42 the content. If the content shall be released,
43 com::sun::star::lang::XComponent::dispose() must
44 be called at the content. The implementation of this method must call
45 com::sun::star::lang::XEventListener::disposing()
46 on the registered listeners and release the appropriate object
47 references. At the other hand, the implementation of
48 XEventListener::disposing must release its appropriate references.
50 <p>This interface is required.
51 */
54 /** enables the caller to let the content execute commands.
56 <p>It is strongly recommended that any implementation supports the
57 improved XCommandProcessor2 interface.</p>
59 <p>Typical commands are "open", "delete", "getPropertyValues" and
60 "setPropertyValues". Each content must support a set of standard
61 commands and properties. Also there is a set of predefined optionally
62 commands and properties. A content may define additional commands and
63 properties. </p>
65 <p>This interface is required.</p>
67 <h3>Commands</h3>
68 <h4>Mandatory commands</h4>
70 <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc">
71 <tr>
72 <th>Command Name</th>
73 <th>Return Type</th>
74 <th>Parameters</th>
75 <th>Description</th>
76 </tr>
77 <tr>
78 <td>getCommandInfo</td>
79 <td>XCommandInfo</td>
80 <td>void</td>
81 <td>This command obtains an interface which allows to query
82 information on commands supported by a content.
83 </td>
84 </tr>
85 <tr>
86 <td>getPropertySetInfo</td>
87 <td>com::sun::star::beans::XPropertySetInfo</td>
88 <td>void</td>
89 <td>This command obtains an interface which allows to query
90 information on properties supported by a content.
91 </td>
92 </tr>
93 <tr>
94 <td>getPropertyValues</td>
95 <td>com::sun::star::sdbc::XRow</td>
96 <td>sequence< com::sun::star::beans::Property > aProps</td>
97 <td>This command obtains property values from the content.
98 <blockquote>
99 <b>Note</b>: The execution will not be aborted, if there
100 are properties requested, that are unknown to the
101 content. The returned row object must contain a NULL
102 value in the corresponding column instead.
103 </blockquote>
104 </td>
105 </tr>
106 <tr>
107 <td>setPropertyValues</td>
108 <td>sequence< any ></td>
109 <td>sequence< com::sun::star::beans::PropertyValue > aValues</td>
110 <td>This command sets property values of the content.
111 <p>Note that setPropertyValues does not throw an exception in the case
112 that one or more of the requested property values cannot be set.
113 The implementation should set as much property values as possible.</p>
115 <p>This command returns a sequence< any > which has exactly the same number
116 of elements like the number of properties to set. Every sequence
117 element contains the status for a property. The first sequence
118 elements corresponds to the first element in the sequence of
119 com::sun::star::beans::PropertyValue passed as
120 command argument, and so on. The exceptions will never be passed to
121 a com::sun::star::task::InteractionHandler.</p>
123 <p>Every element in the returned sequence is an any containing:</p>
124 <ul>
125 <li>No value indicates, that the property value was set successfully.</li>
126 <li>com::sun::star::beans::UnknownPropertyException
127 indicates, that the property is not known to the content
128 implementation.</li>
129 <li>com::sun::star::beans::IllegalTypeException
130 indicates, that the data type of the property value is not
131 acceptable.</li>
132 <li>com::sun::star::lang::IllegalAccessException
133 indicates, that the property is constant
134 (com::sun::star::beans::PropertyAttribute::READONLY
135 is set).</li>
136 <li>com::sun::star::lang::IllegalArgumentException
137 indicates, that the property value is not acceptable. For instance,
138 setting an empty title may be illegal.</li>
139 <li>Any other exception derived from com::sun::star::uno::Exception
140 indicates, that the value was not set successfully. For example,
141 this can be an InteractiveAugmentedIOException
142 transporting the error code IOErrorCode::ACCESS_DENIED.</li>
143 </ul>
145 <p>If the value to set is equal to the current value, no exception must
146 be added to the returned sequence</p>
147 </td>
148 </tr>
149 </table>
151 <h4>Optional commands</h4>
152 <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc">
153 <tr>
154 <th>Command Name</th>
155 <th>Return Type</th>
156 <th>Parameters</th>
157 <th>Description</th>
158 </tr>
159 <tr>
160 <td>open</td>
161 <td>XDynamicResultSet</td>
162 <td>OpenCommandArgument2 aOpenCommandArg</td>
163 <td>
164 For <b>folder</b> objects, this command will return an
165 implementation of service DynamicResultSet.
166 <p>The OpenCommandArgument2 members must be
167 filled as follows:</p>
168 <ul>
169 <li>com::sun::star::ucb::OpenCommandArgument::Mode:
170 com::sun::star::ucb::OpenMode::ALL or
171 com::sun::star::ucb::OpenMode::FOLDERS or
172 com::sun::star::ucb::OpenMode::DOCUMENTS.
173 The implementation of the open command MUST support all these modes!
174 </li>
175 <li>com::sun::star::ucb::OpenCommandArgument::Priority:
176 can be set, but implementation may ignore the value
177 </li>
178 <li>com::sun::star::ucb::OpenCommandArgument::Sink:
179 empty( ignored )
180 </li>
181 <li>com::sun::star::ucb::OpenCommandArgument::Properties:
182 The properties for which the result set shall
183 contain the property values. The order of the
184 sequence is the same as the order of result set
185 columns. First element of sequence will be row
186 number one, second will be row number two, ...
187 </li>
188 <li>com::sun::star::ucb::OpenCommandArgument2::SortingInfo:
189 contains sort criteria, if result set shall
190 be sorted, otherwise it can be left empty.
191 </li>
192 </ul>
193 The execution must be aborted by the implementation of this command
194 (by throwing a CommandAbortedException), if an
195 unsupported mode is requested.
196 </td>
197 </tr>
198 <tr>
199 <td>open</td>
200 <td>void</td>
201 <td>OpenCommandArgument2 aOpenCommandArg</td>
202 <td>For non-folder objects, the OpenCommandArgument2
203 struct will be prefilled with a data sink object, which
204 will be filled with the content data.
205 <p>The OpenCommandArgument2 members must be
206 filled as follows:</p>
207 <ul>
208 <li>com::sun::star::ucb::OpenCommandArgument::Mode:
209 com::sun::star::ucb::OpenMode::DOCUMENT or
210 com::sun::star::ucb::OpenMode::DOCUMENT_SHARE_DENY_NONE or
211 com::sun::star::ucb::OpenMode::DOCUMENT_SHARE_DENY_WRITE.
212 Support for DOCUMENT is mandatory, all others are optional.
213 </li>
214 <li>com::sun::star::ucb::OpenCommandArgument::Priority:
215 can be set, but implementation may ignore the value
216 </li>
217 <li>com::sun::star::ucb::OpenCommandArgument::Sink:
218 a sink, where the implementation can put the document data into.
219 </li>
220 <li>com::sun::star::ucb::OpenCommandArgument::Properties: empty ( ignored )</li>
221 <li>com::sun::star::ucb::OpenCommandArgument2::SortingInfo: empty ( ignored )</li>
222 </ul>
223 <p>The execution must be aborted by the implementation of this command
224 (by throwing a CommandAbortedException), if an
225 unsupported mode is requested.</p>
226 </td>
227 </tr>
228 <tr>
229 <td>createNewContent</td>
230 <td>XContent</td>
231 <td>ContentInfo contentinfo</td>
232 <td>
233 This command creates a new <b>non-persistent</b> content of a given type.
234 <p>This command must be supported by every Content
235 that supports the property "CreatableContentsInfo", if the returned
236 property value contains a non-empty sequence of creatable types.
237 <blockquote>
238 Note: This command is part of the replacement for the deprecated
239 interface XContentCreator.
240 </blockquote>
241 <p>Creation of a new <b>persistent</b> content:
242 <ol>
243 <li>creatabletypes = obtain "CreatableContentsInfo" property from creator</li>
244 <li>choose a suitable type from creatabletypes</li>
245 <li>newObject = execute command "createNewContent(type)" at creator</li>
246 <li>initialize the new object (i.e. newObject.Property1 = ...)</li>
247 <li>execute command "insert" at new content. This command
248 commits the data and makes the new content persistent.</li>
249 </ol>
250 </td>
251 </tr>
252 <tr>
253 <td>insert</td>
254 <td>void</td>
255 <td>InsertCommandArgument aInsertCommandArg</td>
256 <td>
257 <ol>
258 <li>
259 This command inserts a <b>new content</b>. It commits the process of
260 creating a new content via executing the command "createNewContent"
261 and initializing it via setting properties, afterwards.<br>
262 The command is not called on the content which created the new
263 content, because the new object already knows where it is to be
264 inserted (i.e. Calling createNewContent with the content type for a
265 message on a News Group creates a content which internally belongs
266 to the Outbox. Calling "insert" on that message will result in
267 posting the article to the appropriate News Group). Not calling
268 "insert" for the new content, i.e. because the user cancels writing
269 a new message, simply discards the new object. No extra call to
270 "delete" is necessary.<br>
271 On successful completion of this command, the parent of the inserted
272 content must propagate the change by notifying a
273 ContentEvent - ContentAction::INSERTED.
274 </li>
275 <li>
276 Additionally this command can be called at any time to overwrite
277 the data of an <b>existing content</b>.
278 </li>
279 </ol>
280 </td>
281 </tr>
282 <tr>
283 <td>update</td>
284 <td>void</td>
285 <td>OpenCommandArgument2 aOpenCommandArg</td>
286 <td>This command triggers an update operation on a content.
287 For example, when "updating" a POP3-Inbox, the content
288 for that box will get and store all new objects on the
289 appropriate server. The inserted contents will be
290 notified by calling
291 XContentEventListener::contentEvent().
292 </td>
293 </tr>
294 <tr>
295 <td>synchronize</td>
296 <td>void</td>
297 <td>OpenCommandArgument2 aOpenCommandArg</td>
298 <td>
299 This command triggers a synchronization operation between locally
300 cached data and remote server's data. For example, when
301 "synchronizing" a POP3-Inbox the content for that box will get and
302 store all new objects and destroy all cached data for objects no
303 longer existing on the server. The inserted/deleted contents will
304 be notified by calling
305 XContent::contentEvent().
306 </td>
307 </tr>
308 <tr>
309 <td>close</td>
310 <td>void</td>
311 <td>void</td>
312 <td>This command closes an object.</td>
313 </tr>
314 <tr>
315 <td>delete</td>
316 <td>void</td>
317 <td>boolean bDeletePhysically</td>
318 <td>
319 This command deletes an object. If `TRUE` is passed as parameter,
320 the object will be destroyed physically. Otherwise it will be put
321 into trash can, if such a service is available and the object to
322 be deleted supports the command "undelete".
323 On successful completion of this command, the deleted content
324 must propagate its deletion by notifying a ContentEvent
325 - ContentAction::DELETED. Additionally, the contents
326 parent must notify a ContentEvent
327 - ContentAction::REMOVED
328 </td>
329 </tr>
330 <tr>
331 <td>undelete</td>
332 <td>void</td>
333 <td>void</td>
334 <td>
335 This command restores an object previously deleted into trash. It
336 must be supported by objects which claim to be undeletable, but
337 should never be called directly.
338 </td>
339 </tr>
340 <tr>
341 <td>search</td>
342 <td>XDynamicResultSet</td>
343 <td>SearchCommandArgument aSearchCommandArg</td>
344 <td>
345 This command searches for subcontents of a content matching the
346 given search criteria. The command will return an implementation
347 of service DynamicResultSet.
348 </td>
349 </tr>
350 <tr>
351 <td>transfer</td>
352 <td>void</td>
353 <td>TransferInfo aTransferInfo</td>
354 <td>
355 <blockquote>
356 <b>Important note:</b> A client that wants to transfer data should
357 not execute this command, but it should execute the command
358 "globalTransfer" at the UniversalContentBroker.
359 This command is able to transfer all kind of content
360 supported by that UCB.
361 </blockquote>
362 This command transfers (copies/moves) an object from one location
363 to another. It must be executed at the folder content representing
364 the <b>destination</b> of the transfer operation.<br>
365 Note that the implementation need not be able to handle
366 any type of contents.<br>
367 Generally, there are good chances that a transfer of a content will
368 succeed, if source and target folder have the same URL scheme.
369 But there is no guaranty for that.<br>
370 For instance, moving a message from a folder on IMAP server A
371 to a folder on IMAP server B may fail, because the transfer
372 command can't be implemented efficiently for this scenario,
373 because it is not directly supported by the IMAP protocol.
374 On the other hand, moving a message from one folder to
375 another folder on the same IMAP server should work, because it can
376 be implemented efficiently.<br>
377 If an implementation is not able to handle a given source URL,
378 it should indicate this by issuing a
379 InteractiveBadTransferURLException interaction request.<br>
380 Source and target folder may be the same when doing a move operation.
381 <br>
382 Transfers without the transfer command can be done as follows:
383 <ol>
384 <li>Create a new content at the target folder<br>
385 <code>targetContent = target.execute( "createNewContent", type )</code>
386 </li>
387 <li>Transfer data from source to target content<br>
388 <code>props = sourceContent.execute( "getPropertyValues", ... )</code>
389 <code>dataStream = sourceContent.execute( "open", ... )</code>
390 <code>targetContent.execute( "setPropertyValues", props )</code>
391 </li>
392 <li>Insert ( commit ) the new content<br>
393 <code>targetContent.execute( "insert", dataStream )</code>
394 </li>
395 <li>For move operations only: destroy the source content<br>
396 <code>sourceContent.execute( "delete", ... )</code>
397 </li>
398 </ol>
399 <p>This mechanism should work for all transfer operations, but generally
400 it's less efficient than the transfer command.</p>
401 </td>
402 </tr>
403 <tr>
404 <td>lock</td>
405 <td>void</td>
406 <td>void</td>
407 <td>
408 This command obtains an exclusive write lock for the resource. The
409 lock is active until command "unlock" is executed, or the OOo
410 session that obtained the lock ends, or until the lock is released by
411 a third party (e.g. a system administrator).<br>
412 Exceptions:
413 <ul>
414 <li>InteractiveLockingLockedException</li>
415 <li>InteractiveLockingLockExpiredException</li>
416 </ul>
417 </td>
418 </tr>
419 <tr>
420 <td>unlock</td>
421 <td>void</td>
422 <td>void</td>
423 <td>
424 This command removes a lock obtained by executing the command "lock"
425 from the resource.<br>
426 <p>Exceptions:
427 <ul>
428 <li>InteractiveLockingLockedException</li>
429 <li>InteractiveLockingLockExpiredException</li>
430 </ul>
431 </p>
432 <p>Note that InteractiveLockingLockExpiredException might
433 be raised by any command that requires a previously obtained lock.
434 </p>
435 </td>
436 </tr>
437 <tr>
438 <td>addProperty</td>
439 <td>void</td>
440 <td>PropertyCommandArgument aCmdArg</td>
441 <td>
442 Adds a new properties to the content.
443 <p>
444 PropertyCommandArgument::Property
445 contains information about the property to be added.
446 PropertyCommandArgument::DefaultValue
447 may contain the default value for the property. Its type must
448 match the one specified in com::sun::star::beans::Property::Type.
449 </p>
450 <p>Note that the dynamic properties must be kept persistent. The
451 service Store (UCB persistence service) may be used to
452 implement this.</p>
453 <p><b>Important:</b> The implementation must at least support
454 adding properties of the following basic data types:</p>
455 <p>
456 <ul>
457 <li>boolean
458 <li>char
459 <li>byte
460 <li>string
461 <li>short
462 <li>long
463 <li>hyper
464 <li>float
465 <li>double
466 </ul>
467 </p>
468 <p>
469 Raises a ::com::sun::star::beans::PropertyExistException
470 if a property with the same name already exists;
471 ::com::sun::star::beans::IllegalTypeException
472 if the property has an unsupported type;
473 ::com::sun::star::lang::IllegalArgumentException
474 if the Name of the property is empty.</p>
475 <blockquote>
476 Note: This command is new since Apache OpenOffice 4.0, LibreOffice 4.2 and replaces the deprecated interface method
477 com::sun::star::beans::XPropertyContainer::addProperty.
478 </blockquote>
479 </td>
480 </tr>
481 <tr>
482 <td>removeProperty</td>
483 <td>void</td>
484 <td>string PropertyName</td>
485 <td>Removes the properties from the content.
486 <p>Raises a ::com::sun::star::beans::UnknownPropertyException
487 if the property does not exist;
488 ::com::sun::star::beans::NotRemoveableException
489 if the property is not removable.</p>
490 <blockquote>
491 Note: This command is new since Apache OpenOffice 4.0, LibreOffice 4.2 and replaces the deprecated interface method
492 com::sun::star::beans::XPropertyContainer::removeProperty.
493 </blockquote>
494 </td>
495 </tr>
496 </table>
498 <h3>Properties</h3>
499 <h4>Mandatory properties</h4>
501 <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc">
502 <tr>
503 <th>Name</th>
504 <th>Type</th>
505 <th>Description</th>
506 </tr>
507 <tr>
508 <td>ContentType</td>
509 <td>string</td>
510 <td>
511 contains a unique type string for the content
512 ( i.e. "application/vnd.sun.star.hierarchy-link" ).
513 <p>This property is always read-only.</p>
514 <p>The ContentType should not be confused with the MIME
515 media type ( MIME types ) of the content. Media types
516 may be provided through the optional property "MediaType".</p>
517 <p>The value of this property should match the information on creatable
518 contents given by UCB contents that implement the property
519 "CreatableContentsInfo".</p>
520 </td>
521 </tr>
522 <tr>
523 <td>IsFolder</td>
524 <td>boolean</td>
525 <td>indicates, whether a content can contain other contents.</td>
526 </tr>
527 <tr>
528 <td>IsDocument</td>
529 <td>boolean</td>
530 <td>indicates, whether a content is a document. This means,
531 the content can dump itself into a data sink.
532 </td>
533 </tr>
534 <tr>
535 <td>Title</td>
536 <td>string</td>
537 <td>contains the title of an object (e.g. the subject of a message).</td>
538 </tr>
539 </table>
541 <h4>Optional properties</h4>
543 <table style="border-width: 1px; border-spacing: 0px; border-style: solid; border-color: gray; border-collapse: collapse; background-color: white;" class="devdoc">
544 <tr>
545 <th>Name</th>
546 <th>Type</th>
547 <th>Description</th>
548 </tr>
549 <tr>
550 <td>AutoUpdateInterval</td>
551 <td>long</td>
552 <td>contains the interval for automatic updates of an object.
553 It is specified in seconds.
554 </td>
555 </tr>
556 <tr>
557 <td>ConnectionLimit</td>
558 <td>short</td>
559 <td>contains the maximum number of network connections
560 allowed for one (internet) protocol at a time. (e.g. The HTTP
561 cache can be configured to use a maximum for the number of
562 connections used for browsing.)
563 </td>
564 </tr>
565 <tr>
566 <td>ConnectionMode</td>
567 <td>short</td>
568 <td>contains the current connection mode for the object.
569 (see ConnectionMode)
570 </td>
571 </tr>
572 <tr>
573 <td>CreatableContentsInfo</td>
574 <td>sequence ContentInfo</td>
575 <td>
576 contains the types of Contents a Content object can create via
577 command "createNewContent".
578 <p>If the property value can be a non-empty sequence, the
579 Content must also support command "createNewContent".</p>
580 <blockquote>
581 Note: This property is part of the replacement for the deprecated
582 interface XContentCreator.
583 </blockquote>
584 </td>
585 </tr>
586 <tr>
587 <td>DateCreated</td>
588 <td>com::sun::star::util::DateTime</td>
589 <td>contains the date and time the object was created.</td>
590 </tr>
591 <tr>
592 <td>DateModified</td>
593 <td>com::sun::star::util::DateTime</td>
594 <td>contains the date and time the object was last modified.</td>
595 </tr>
596 <tr>
597 <td>DocumentCount</td>
598 <td>long</td>
599 <td>contains the count of documents of a folder.</td>
600 </tr>
601 <tr>
602 <td>DocumentCountMarked</td>
603 <td>long</td>
604 <td>contains the count of marked documents within a folder.</td>
605 </tr>
606 <tr>
607 <td>DocumentHeader</td>
608 <td>sequence< DocumentHeaderField > </td>
609 <td>contains a sequence of document header fields (i.e. header
610 fields of a MIME-message, or the document info of an
611 office document ). For some standard header fields there
612 are predefined separate properties, like "MessageTo".
613 </td>
614 </tr>
615 <tr>
616 <td>DocumentStoreMode</td>
617 <td>DocumentStoreMode</td>
618 <td>contains information about the way a folder stores the
619 contents of (remote) documents.
620 </td>
621 </tr>
622 <tr>
623 <td>FolderCount</td>
624 <td>long</td>
625 <td>contains the count of subfolders of a folder.</td>
626 </tr>
627 <tr>
628 <td>FreeSpace</td>
629 <td>hyper</td>
630 <td>contains the free space left on a storage device. It is
631 specified in bytes.</td>
632 </tr>
633 <tr>
634 <td>HasDocuments</td>
635 <td>boolean</td>
636 <td>indicates whether a content has subcontents, which are documents.</td>
637 </tr>
638 <tr>
639 <td>HasFolders</td>
640 <td>boolean</td>
641 <td>indicates whether a content has subcontents, which are folders.</td>
642 </tr>
643 <tr>
644 <td>IsMarked</td>
645 <td>boolean</td>
646 <td>indicates whether a content is "marked".</td>
647 </tr>
648 <tr>
649 <td>IsRead</td>
650 <td>boolean</td>
651 <td>indicates whether a content has been "read".</td>
652 </tr>
653 <tr>
654 <td>IsReadOnly</td>
655 <td>boolean</td>
656 <td>indicates whether a content is read-only.</td>
657 </tr>
658 <tr>
659 <td>IsSubscribed</td>
660 <td>boolean</td>
661 <td>indicates whether a content is subscribed.</td>
662 </tr>
663 <tr>
664 <td>IsTimeLimitedStore</td>
665 <td>boolean</td>
666 <td>indicates whether the feature to store contents
667 depending on their age is active.</td>
668 </tr>
669 <tr>
670 <td>UpdateOnOpen</td>
671 <td>boolean</td>
672 <td>indicates whether (sub)contents shall be automatically updated
673 every time a (folder) content is opened.<br>This property may be
674 used to control whether a folder content should read data only
675 from local cache when it is opened, or whether it should connect
676 to a server to obtain latest data.</td>
677 </tr>
678 <tr>
679 <td>Keywords</td>
680 <td>string</td>
681 <td>contains the keywords of a document (e.g. the value
682 of the "keywords" header field of a news article).</td>
683 </tr>
684 <tr>
685 <td>MediaType</td>
686 <td>string</td>
687 <td>contains the media type ( MIME type ) of a content. It is highly
688 recommended to support this property if the content's implementation
689 can obtain the media type natively from its data source ( i.e.
690 HTTP servers provide media types for all their documents ).
691 </td>
692 </tr>
693 <tr>
694 <td>MessageBCC</td>
695 <td>string</td>
696 <td>contains the BCC (blind carbon copy) receiver(s) of a message.</td>
697 </tr>
698 <tr>
699 <td>MessageCC</td>
700 <td>string</td>
701 <td>contains the CC (carbon copy) receiver(s) of a message.</td>
702 </tr>
703 <tr>
704 <td>MessageFrom</td>
705 <td>string</td>
706 <td>contains (the address of) the sender of a message.</td>
707 </tr>
708 <tr>
709 <td>MessageId</td>
710 <td>string</td>
711 <td>contains the ID of a message.</td>
712 </tr>
713 <tr>
714 <td>MessageInReplyTo</td>
715 <td>string</td>
716 <td>contains the "In-Reply-To" field of a message.</td>
717 </tr>
718 <tr>
719 <td>MessageReplyTo</td>
720 <td>string</td>
721 <td>contains the "Reply-To" field of a message.</td>
722 </tr>
723 <tr>
724 <td>MessageTo</td>
725 <td>string</td>
726 <td>contains the recipient(s) of a message.</td>
727 </tr>
728 <tr>
729 <td>NewsGroups</td>
730 <td>string</td>
731 <td>contains the name(s) of the newsgroup(s) into which a message was posted.</td>
732 </tr>
733 <tr>
734 <td>Password</td>
735 <td>string</td>
736 <td>contains a password (e.g. needed to access a POP3-Server).</td>
737 </tr>
738 <tr>
739 <td>Priority</td>
740 <td>Priority</td>
741 <td>contains a priority (i.e. of a message).</td>
742 </tr>
743 <tr>
744 <td>References</td>
745 <td>string</td>
746 <td>contains the "References" field of a news article.</td>
747 </tr>
748 <tr>
749 <td>Rules</td>
750 <td>RuleSet</td>
751 <td>contains the rules set for a content.</td>
752 </tr>
753 <tr>
754 <td>SeenCount</td>
755 <td>long</td>
756 <td>contains the count of seen/read subcontents of a folder content.</td>
757 </tr>
758 <tr>
759 <td>ServerBase</td>
760 <td>string</td>
761 <td>contains the base directory to use on a server. (e.g. Setting
762 the server base of an FTP-Account to "/pub/incoming"
763 will result in showing contents from that directory and not from
764 server's root directory)
765 </td>
766 </tr>
767 <tr>
768 <td>ServerName</td>
769 <td>string</td>
770 <td>contains a server name (e.g. The name of the server to use for
771 a POP3-Account).
772 </td>
773 </tr>
774 <tr>
775 <td>ServerPort</td>
776 <td>short</td>
777 <td>contains a numeric server port.</td>
778 </tr>
779 <tr>
780 <td>Size</td>
781 <td>hyper</td>
782 <td>contains the size (usually in bytes) of an object.</td>
783 </tr>
784 <tr>
785 <td>SizeLimit</td>
786 <td>hyper</td>
787 <td>contains a size limit for an object. (e.g. One may specify the
788 maximum size of the HTTP-Cache)
789 </td>
790 </tr>
791 <tr>
792 <td>SubscribedCount</td>
793 <td>long</td>
794 <td>contains the count of subscribed contents of a folder.</td>
795 </tr>
796 <tr>
797 <td>SynchronizePolicy</td>
798 <td>SynchronizePolicy</td>
799 <td>contains the policy to use when synchronizing two objects.</td>
800 </tr>
801 <tr>
802 <td>TargetFrames</td>
803 <td>string</td>
804 <td>contains information about the target frame to use when displaying
805 an object.
806 <p>The value is a string containing three tokens, separated by ";"
807 (A semicolon):<br/>
808 <dl>
809 <dt>1st token</dt>
810 <dd>Behavior on "select" ( single click )</dd>
811 <dt>2nd token</dt>
812 <dd>Behavior on "open" ( double click )</dd>
813 <dt>3rd token</dt>
814 <dd>Behavior on "open in new task" ( double click + CTRL key )</dd>
815 </dl>
816 </p>
817 <p> Each token may contain the following values:<br/>
818 <dl>
819 <dt>"_beamer"</dt>
820 <dd>Show in "Beamer"</dd>
821 <dt>"_top"</dt>
822 <dd>Show in current frame (replaces old)</dd>
823 <dt>"_blank"</dt>
824 <dd>Show in new task</dd>
825 </dl>
826 </p>
827 </td>
828 </tr>
829 <tr>
830 <td>TargetURL</td>
831 <td>string</td>
832 <td>for contents that are links to other contents, contains the URL of
833 the target content</td>
834 </tr>
835 <tr>
836 <td>TimeLimitStore</td>
837 <td>short</td>
838 <td>contains the value to use if the property "IsTimeLimitedStore" is set.</td>
839 </tr>
840 <tr>
841 <td>UserName</td>
842 <td>string</td>
843 <td>contains a user name. (e.g. the user name needed to access a
844 POP3-Account)</td>
845 </tr>
846 <tr>
847 <td>VerificationMode</td>
848 <td>VerificationMode </td>
849 <td>describes a verification policy.</td>
850 </tr>
851 </table>
852 */
856 /** is an enhanced version of XCommandProcessor that has an
857 additional method for releasing command identifiers obtained via
858 XCommandProcessor::createCommandIdentifier() to avoid
859 resource leaks. For a detailed description of the problem refer to
860 XCommandProcessor2::releaseCommandIdentifier().
862 <p>Where many existing Content implementations do not
863 (yet), every new implementation should support this interface.
864 */
867 /** notifies changes of property values to listeners registered for
868 those properties.
870 <p>This interface is required.
871 */
874 /** can be used to add new properties to the content and to remove
875 properties from the content dynamically.
877 <p>Note that the dynamic properties must be kept persistent. The
878 service Store (UCB persistence service) may be used to
879 implement this.
881 <p><b>Important:</b> The implementation of
882 com::sun::star::beans::XPropertyContainer::addProperty()
883 must at least support adding properties of the following basic data
884 types:
886 <p>
887 <ul>
888 <li>boolean
889 <li>char
890 <li>byte
891 <li>string
892 <li>short
893 <li>long
894 <li>hyper
895 <li>float
896 <li>double
897 </ul>
898 </p>
900 <p>If a property with an unsupported type shall be added a
901 com::sun::star::beans::IllegalTypeException must
902 be raised.
904 @deprecated
905 <p>This interface is <b>deprecated</b>, because a
906 ContentProvider might need a
907 XCommandEnvironment to perform the tasks of adding and
908 removing properties. New implementations should implement the
909 respective commands "addProperty" and "removeProperty" instead.
910 */
913 /** can be used to notify properties removed from or added to the
914 content's property set.
916 <p>This interface must be implemented, if the implementation can
917 dynamically change it's property set ( e.g. because it implements
918 the interface
919 com::sun::star::beans::XPropertyContainer. )
920 */
923 /** can be used to notify commands removed from or added to the
924 content's command set.
926 <p>This interface must be implemented, if the implementation can
927 dynamically change it's command set ( e.g. because the set of
928 available commands depends on the value of a property of the
929 content ).
931 <p>This interface is optional.
932 */
935 /** creates new contents (i.e. creates a new folder in another folder
936 somewhere in the local file system).
938 <p>A content is "new", if it does not physically exist before creating
939 it using this interface.
941 <p>This interface is optional. It should be implemented by contents
942 which shall be able to create new objects.
944 @deprecated
946 <p>This interface is <b>deprecated</b>. Use property
947 "CreatableContentsInfo" and command "createNewContent" instead.
948 */
951 /** provides access to the parent content of this content.
953 <p>The object returned by the implementation of the method
954 com::sun::star::container::XChild::getParent()
955 must implement the service Content. If the content is a
956 root object, an empty interface may be returned.
958 <p>This interface must be implemented by a content which is a (logical)
959 child of a content.
960 */
962 };
965 }; }; }; };
967 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */