offapi/com/sun/star/ucb/XRemoteContentProviderDistributor.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: XRemoteContentProviderDistributor.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 #ifndef __com_sun_star_ucb_XRemoteContentProviderDistributor_idl__
  31 #define __com_sun_star_ucb_XRemoteContentProviderDistributor_idl__
  32
  33 #ifndef __com_sun_star_connection_ConnectionSetupException_idl__
  34 #include <com/sun/star/connection/ConnectionSetupException.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_connection_NoConnectException_idl__
  38 #include <com/sun/star/connection/NoConnectException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  42 #include <com/sun/star/lang/IllegalArgumentException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_uno_XInterface_idl__
  46 #include <com/sun/star/uno/XInterface.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52 module com { module sun { module star { module ucb {
  53
  54 //=============================================================================
  55 /** Distribute a content broker to variuos
  56     <type>XRemoteContentProviderAcceptor</type>s.
  57
  58     @version 1.0
  59     @author Stephan Bergmann
  60     @see XRemoteContentProviderAcceptor
  61 */
  62 published interface XRemoteContentProviderDistributor: com::sun::star::uno::XInterface
  63 {
  64     //-------------------------------------------------------------------------
  65     /** Offer the local content broker to a remote content provider acceptor.
  66
  67         <p> The Uno Url is handed to the
  68         <type scope="com::sun::star::bridge">UnoUrlResolver</type> service,
  69         which is responsible for raising any of the advertised exceptions. </p>
  70
  71         @param Url  A Uno Url to address the
  72         <type>XRemoteContentProviderAcceptor</type>.
  73
  74         @param Identifier  An identifier handed to the
  75         <type>XRemoteContentProviderAcceptor</type>.
  76
  77         @returns success indicator.  Escpecially, if there's already a
  78         connection to the given Url, the call will fail, no matter whether
  79         that connection uses the same identifier as the given one or not.
  80     */
  81     boolean connectToRemoteAcceptor([in] string Url,
  82                                     [in] string Identifier)
  83         raises (com::sun::star::connection::NoConnectException,
  84                 com::sun::star::connection::ConnectionSetupException,
  85                 com::sun::star::lang::IllegalArgumentException);
  86
  87     //-------------------------------------------------------------------------
  88     /** Undo the offering of the local content broker to a specific remote
  89         content provider acceptor.
  90
  91         @param Url  A Uno Url to address the
  92         <type>XRemoteContentProviderAcceptor</type>.
  93
  94         @returns success indicator.
  95     */
  96     boolean disconnectFromRemoteAcceptor([in] string Url);
  97
  98     //-------------------------------------------------------------------------
  99     /** Undo the offering of the local content broker to all remote content
 100         provider acceptors.
 101     */
 102     void disconnectFromAll();
 103 };
 104
 105 //=============================================================================
 106
 107 }; }; }; };
 108
 109 #endif