offapi/com/sun/star/ucb/RemoteProxyContentProvider.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: RemoteProxyContentProvider.idl,v $
  10  * $Revision: 1.6 $
  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
  31 #ifndef __com_sun_star_ucb_RemoteProxyContentProvider_idl__
  32 #define __com_sun_star_ucb_RemoteProxyContentProvider_idl__
  33
  34 module com { module sun { module star { module ucb {
  35
  36  published interface XContentIdentifierFactory;
  37  published interface XContentProvider;
  38  published interface XParameterizedContentProvider;
  39
  40 //============================================================================
  41 /** A <type>ContentProvider</type> that wraps remote content providers that
  42     (potentially) have been distributed to a UCB.
  43
  44     <p>Before trying to pass a request to a 'real,' underlying content provider
  45     (which will most likely be a remote content provider distributed to this
  46     UCB), this proxy first activates any remote content providers that have
  47     been distributed here, but are still inactive (see
  48     <type>RemoteContentProviderAcceptor</type> and
  49     <type>XRemoteContentProviderActivator</type> for more information).
  50
  51     <p>The way this works might change, therefore this interface is marked as
  52     deprectated.
  53
  54     @deprecated
  55  */
  56 published service RemoteProxyContentProvider
  57 {
  58     //------------------------------------------------------------------------
  59     /** activates any potentially inactive remote content providers before
  60         passing on requests to the underlying <type>XContentProvider</type>.
  61      */
  62     interface XContentProvider;
  63
  64     //------------------------------------------------------------------------
  65     /** activates any potentially inactive remote content providers before
  66         passing on requests to the underlying
  67         <type>XContentIdentifierFactory</type>.
  68      */
  69     [optional] interface XContentIdentifierFactory;
  70
  71     //------------------------------------------------------------------------
  72     /** allows this <type>ContentProvider</type> to adjust itself to special
  73         needs.
  74      */
  75     [optional] interface XParameterizedContentProvider;
  76 };
  77
  78 }; }; }; };
  79
  80 #endif