offapi/com/sun/star/ucb/XRemoteContentProviderActivator.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: XRemoteContentProviderActivator.idl,v $
  10  * $Revision: 1.9 $
  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_XRemoteContentProviderActivator_idl__
  32 #define __com_sun_star_ucb_XRemoteContentProviderActivator_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 module com { module sun { module star { module ucb {
  39
  40  published interface XContentProviderManager;
  41
  42 //============================================================================
  43 /** This interface should be implemented together with
  44     <type>XRemoteContentProviderAcceptor</type> and allows for a lazy
  45     implementation of
  46     <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>.
  47
  48     The way this works might change, therefore this interface is marked as
  49     deprectated.
  50
  51     @deprecated
  52  */
  53 published interface XRemoteContentProviderActivator: com::sun::star::uno::XInterface
  54 {
  55     //------------------------------------------------------------------------
  56     /** Activate (i.e., register at the broker) the remote content providers
  57         that until now have only been remembered by
  58         <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>,
  59         but not registered.
  60
  61         <p>This allows for
  62         <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>
  63         to be implemented in a layz fashion (remember the remote content
  64         providers, but do not register them right away), which can increase
  65         performance in certain situations.  But it is not required that an
  66         implementation of <type>XRemoteContentProviderAcceptor</type> uses this
  67         lazy strategy (and thus also implements this interface).
  68
  69         @return
  70         the broker at which the remote content providers have been registered.
  71      */
  72     XContentProviderManager activateRemoteContentProviders();
  73 };
  74
  75 }; }; }; };
  76
  77 #endif