offapi/com/sun/star/ucb/ContentProviderProxy.idl

   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  */
  19
  20
  21 module com { module sun { module star { module ucb {
  22
  23 /** is a proxy for a content provider.
  24
  25     <p>Implementing a content provider proxy can be useful if the creation of
  26     the real content provider object shall be deferred for some reason
  27     (i.e. performance) until the first method gets called on it. Instead of
  28     instantiating and registering the real provider at the UCB, a proxy for
  29     the real provider can be created and registered at the UCB.
  30
  31     @see XContentProviderProxyFactory
  32 */
  33 published service ContentProviderProxy
  34 {
  35     /** The implementation of
  36         com::sun::star::uno::XInterface::queryInterface()
  37         must instantiate the real provider and return the return value
  38         of a queryInterface call at the real provider, except for queries
  39         for the interfaces implemented by the proxy itself. So the caller of
  40         the queryInterface method at the proxy will get access to the real
  41         provider in a completely transparent way.
  42      */
  43     interface com::sun::star::uno::XInterface;
  44
  45     /** gives access to the original content provider behind the proxy.
  46
  47         <p>The implementation will instantiate the real content provider only
  48         on demand using its UNO service name. This will load the content
  49         providers implementation code (dynamic library), if not already done.
  50      */
  51     interface com::sun::star::ucb::XContentProviderSupplier;
  52
  53     /** a content provider implementation that wraps the original provider.
  54      */
  55     interface com::sun::star::ucb::XContentProvider;
  56
  57     /** a parameterized content provider implementation that wraps the
  58         original provider.
  59      */
  60     interface com::sun::star::ucb::XParameterizedContentProvider;
  61 };
  62
  63
  64 }; }; }; };
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */