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