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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ContentProviderProxy.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_ContentProviderProxy_idl__
  31 #define __com_sun_star_ucb_ContentProviderProxy_idl__
  32
  33 #ifndef __com_sun_star_ucb_XContentProviderSupplier_idl__
  34 #include <com/sun/star/ucb/XContentProviderSupplier.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_XContentProvider_idl__
  38 #include <com/sun/star/ucb/XContentProvider.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_ucb_XParameterizedContentProvider_idl__
  42 #include <com/sun/star/ucb/XParameterizedContentProvider.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com { module sun { module star { module ucb {
  48
  49 //=============================================================================
  50 /** is a proxy for a content provider.
  51
  52     <p>Implementing a content provider proxy can be useful if the creation of
  53     the real content provider object shall be deferred for some reason
  54     (i.e. performance) until the first method gets called on it. Instaead of
  55     instanciating and registering the real provider at the UCB, a proxy for
  56     the real provider can be created and registered at the UCB.
  57
  58     @see XContentProviderProxyFactory
  59 */
  60 published service ContentProviderProxy
  61 {
  62     //-------------------------------------------------------------------------
  63     /** The implementation of
  64         <member scope="com::sun::star::uno">XInterface::queryInterface</member>
  65         must instanciate the real provider and return the return value
  66         of a queryInterface call at the real provider, except for queries
  67         for the interfaces implemented by the proxy itself. So the caller of
  68         the queryInterface method at the proxy will get access to the real
  69         provider in a completely transparent way.
  70      */
  71     interface com::sun::star::uno::XInterface;
  72
  73     //-------------------------------------------------------------------------
  74     /** gives access to the original content provider behind the proxy.
  75
  76         <p>The implementation will instantiate the real content provider only
  77         on demand using its UNO service name. This will load the content
  78         providers implementation code (dynamic library), if not already done.
  79      */
  80     interface com::sun::star::ucb::XContentProviderSupplier;
  81
  82     //-------------------------------------------------------------------------
  83     /** a content provider implementation that wrappes the original provider.
  84      */
  85     interface com::sun::star::ucb::XContentProvider;
  86
  87     //-------------------------------------------------------------------------
  88     /** a parameterized content provider implementation that wrappes the
  89         original provider.
  90      */
  91     interface com::sun::star::ucb::XParameterizedContentProvider;
  92 };
  93
  94 //=============================================================================
  95
  96 }; }; }; };
  97
  98 #endif