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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_ucb_XRemoteContentProviderActivator_idl__
  29 #define __com_sun_star_ucb_XRemoteContentProviderActivator_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 module com { module sun { module star { module ucb {
  36
  37  published interface XContentProviderManager;
  38
  39 //============================================================================
  40 /** This interface should be implemented together with
  41     <type>XRemoteContentProviderAcceptor</type> and allows for a lazy
  42     implementation of
  43     <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>.
  44
  45     The way this works might change, therefore this interface is marked as
  46     deprectated.
  47
  48     @deprecated
  49  */
  50 published interface XRemoteContentProviderActivator: com::sun::star::uno::XInterface
  51 {
  52     //------------------------------------------------------------------------
  53     /** Activate (i.e., register at the broker) the remote content providers
  54         that until now have only been remembered by
  55         <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>,
  56         but not registered.
  57
  58         <p>This allows for
  59         <member>XRemoteContentProviderAcceptor::addRemoteContentProvider</member>
  60         to be implemented in a layz fashion (remember the remote content
  61         providers, but do not register them right away), which can increase
  62         performance in certain situations.  But it is not required that an
  63         implementation of <type>XRemoteContentProviderAcceptor</type> uses this
  64         lazy strategy (and thus also implements this interface).
  65
  66         @return
  67         the broker at which the remote content providers have been registered.
  68      */
  69     XContentProviderManager activateRemoteContentProviders();
  70 };
  71
  72 }; }; }; };
  73
  74 #endif