xref: /AOO41X/main/offapi/com/sun/star/ucb/XRemoteContentProviderAcceptor.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_XRemoteContentProviderAcceptor_idl__
24#define __com_sun_star_ucb_XRemoteContentProviderAcceptor_idl__
25
26#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
27#include <com/sun/star/lang/XMultiServiceFactory.idl>
28#endif
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34
35//=============================================================================
36
37module com { module sun { module star { module ucb {
38
39 published interface XRemoteContentProviderDoneListener;
40
41//=============================================================================
42/** Accept remote content providers that want to make themselves known to the
43    local process.
44
45    @version 1.0
46    @author Stephan Bergmann
47*/
48published interface XRemoteContentProviderAcceptor: com::sun::star::uno::XInterface
49{
50    //-------------------------------------------------------------------------
51    /** Add a remote content provider.
52
53        @param Identifier  An arbitrary identifier uniquely identifying the
54        remote content provider.
55
56        @param Factory  A factory through which the remote content provider's
57        <type>UniversalContentBroker</type> service can be instantiated.
58
59        @param Templates  A sequence of URL templates the remote content
60        provider is willing to handle.
61
62        @param DoneListener  If not null, the implementation of this interface
63        can---through this callback---tell the calling side that the
64        implementation no longer needs the remote content provider.  (And the
65        calling side should call
66        <member>XRemoteContentProviderAcceptor::removeRemoteContentProvider</member>
67        then.)
68
69        To enable connection control, it is recommended that this argument
70        also implements the interface
71        <type>XRemoteContentProviderConnectionControl</type>.
72
73        @return  true if the remote content provider has successfully been
74        added.
75    */
76    boolean
77    addRemoteContentProvider([in] string Identifier,
78                             [in] com::sun::star::lang::XMultiServiceFactory
79                                     Factory,
80                             [in] sequence< string > Templates,
81                             [in] XRemoteContentProviderDoneListener
82                                     DoneListener);
83
84    //-------------------------------------------------------------------------
85    /** Remove a remote content provider.
86
87        @param Identifier  An arbitrary identifier uniquely identifying the
88        remote content provider.
89
90        @return  true if the remote content provider has successfully been
91        removed.
92    */
93    boolean
94    removeRemoteContentProvider([in] string Identifier);
95};
96
97//=============================================================================
98
99}; }; }; };
100
101#endif
102