offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.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: XRemoteContentProviderAcceptor.idl,v $
  10  * $Revision: 1.12 $
  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_XRemoteContentProviderAcceptor_idl__
  31 #define __com_sun_star_ucb_XRemoteContentProviderAcceptor_idl__
  32
  33 #ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
  34 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_uno_XInterface_idl__
  38 #include <com/sun/star/uno/XInterface.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module ucb {
  45
  46  published interface XRemoteContentProviderDoneListener;
  47
  48 //=============================================================================
  49 /** Accept remote content providers that want to make themselves known to the
  50     local process.
  51
  52     @version 1.0
  53     @author Stephan Bergmann
  54 */
  55 published interface XRemoteContentProviderAcceptor: com::sun::star::uno::XInterface
  56 {
  57     //-------------------------------------------------------------------------
  58     /** Add a remote content provider.
  59
  60         @param Identifier  An arbitrary identifier uniquely identifying the
  61         remote content provider.
  62
  63         @param Factory  A factory through which the remote content provider's
  64         <type>UniversalContentBroker</type> service can be instantiated.
  65
  66         @param Templates  A sequence of URL templates the remote content
  67         provider is willing to handle.
  68
  69         @param DoneListener  If not null, the implementation of this interface
  70         can---through this callback---tell the calling side that the
  71         implementation no longer needs the remote content provider.  (And the
  72         calling side should call
  73         <member>XRemoteContentProviderAcceptor::removeRemoteContentProvider</member>
  74         then.)
  75
  76         To enable connection control, it is recommended that this argument
  77         also implements the interface
  78         <type>XRemoteContentProviderConnectionControl</type>.
  79
  80         @return  true if the remote content provider has successfully been
  81         added.
  82     */
  83     boolean
  84     addRemoteContentProvider([in] string Identifier,
  85                              [in] com::sun::star::lang::XMultiServiceFactory
  86                                      Factory,
  87                              [in] sequence< string > Templates,
  88                              [in] XRemoteContentProviderDoneListener
  89                                       DoneListener);
  90
  91     //-------------------------------------------------------------------------
  92     /** Remove a remote content provider.
  93
  94         @param Identifier  An arbitrary identifier uniquely identifying the
  95         remote content provider.
  96
  97         @return  true if the remote content provider has successfully been
  98         removed.
  99     */
 100     boolean
 101     removeRemoteContentProvider([in] string Identifier);
 102 };
 103
 104 //=============================================================================
 105
 106 }; }; }; };
 107
 108 #endif