Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: ucb ::
interface XUniversalContentBroker
  Base Interfaces
      XUniversalContentBroker
      ┣ ::com::sun::star::lang::XComponent
      ┣ XContentProvider
      ┣ XContentProviderManager
      ┣ XContentIdentifierFactory
      ┗ XCommandProcessor2
         ┗ XCommandProcessor
  ::com::sun::star::lang::XComponent | Description must be implemented to make it possible to resolve cyclic object references. Those references i.e. may occur if content provider implementations hold references to the Broker. The Broker itself always holds its providers. If the Broker shall be released, ::com::sun::star::lang::XComponent::dispose must be called at the Broker. The implementation of this method must call ::com::sun::star::lang::XEventListener::disposing on the registered listeners (the providers holding the Broker must be those listeners) and release the appropriate object references. At the other hand, the implementation of XEventListener::disposing must release its appropriate references. This interface is required.
  XContentProvider | Description provides access to all kind of contents provided by the registered content providers. This interface is required.
  XContentProviderManager | Description provides access to a set of content providers registered with the UCB. This interface is required.
  XContentIdentifierFactory | Description creates XContentIdentifier implementation objects for all kind of contents provided by the UCB. This interface is required.
    XCommandProcessor2 | Description Enables the caller to execute commands at the broker. Is an enhanced version of XCommandProcessor that has an additional method for releasing command identifiers obtained via XCommandProcessor::createCommandIdentifier to avoid resource leaks. For a detailed description of the problem refer to XCommandProcessor2::releaseCommandIdentifier. This interface is required.
         =======================================================================
         Commands:
         =======================================================================

         [return type]
         [command name]
         [parameter type and name]

         -----------------------------------------------------------------------
         Required commands:
         -----------------------------------------------------------------------

         // This command obtains an interface which allows to query
         // information on commands supported by the Content Broker.

         XCommandInfo
         getCommandInfo
         void

         // This command transfers Contents from one location to another.
         // Additionally, it can be used to create a link to a Content.
         // The implementation must be able to handle Contents provided
         // by any Content Provider. This is different from the command
         // "transfer" that can be supported by a Content. That command
         // typically can only handle Contents provided by one
         // ContentProvider.

         void
         globalTransfer
         GlobalTransferCommandArgument
Since LibreOffice 4.0

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.