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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_XRemoteContentProviderDistributor_idl__
  20 #define __com_sun_star_ucb_XRemoteContentProviderDistributor_idl__
  21
  22 #include <com/sun/star/connection/ConnectionSetupException.idl>
  23 #include <com/sun/star/connection/NoConnectException.idl>
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25 #include <com/sun/star/uno/XInterface.idl>
  26
  27
  28
  29 module com { module sun { module star { module ucb {
  30
  31 /** Distribute a content broker to various
  32     XRemoteContentProviderAcceptors.
  33
  34     @version 1.0
  35     @author Stephan Bergmann
  36     @see XRemoteContentProviderAcceptor
  37 */
  38 published interface XRemoteContentProviderDistributor: com::sun::star::uno::XInterface
  39 {
  40     /** Offer the local content broker to a remote content provider acceptor.
  41
  42         <p> The Uno Url is handed to the
  43         com::sun::star::bridge::UnoUrlResolver service,
  44         which is responsible for raising any of the advertised exceptions. </p>
  45
  46         @param Url  A Uno Url to address the
  47         XRemoteContentProviderAcceptor.
  48
  49         @param Identifier  An identifier handed to the
  50         XRemoteContentProviderAcceptor.
  51
  52         @returns success indicator.  Especially, if there's already a
  53         connection to the given Url, the call will fail, no matter whether
  54         that connection uses the same identifier as the given one or not.
  55     */
  56     boolean connectToRemoteAcceptor([in] string Url,
  57                                     [in] string Identifier)
  58         raises (com::sun::star::connection::NoConnectException,
  59                 com::sun::star::connection::ConnectionSetupException,
  60                 com::sun::star::lang::IllegalArgumentException);
  61
  62     /** Undo the offering of the local content broker to a specific remote
  63         content provider acceptor.
  64
  65         @param Url  A Uno Url to address the
  66         XRemoteContentProviderAcceptor.
  67
  68         @returns success indicator.
  69     */
  70     boolean disconnectFromRemoteAcceptor([in] string Url);
  71
  72     /** Undo the offering of the local content broker to all remote content
  73         provider acceptors.
  74     */
  75     void disconnectFromAll();
  76 };
  77
  78
  79 }; }; }; };
  80
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */