xref: /trunk/main/offapi/com/sun/star/ucb/RemoteProxyContentProvider.idl (revision 9c9d9658c5c7e4a65453d7bfdc82f55dc0fd0331)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19cdf0e10cSrcweir *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_ucb_RemoteProxyContentProvider_idl__
25cdf0e10cSrcweir#define __com_sun_star_ucb_RemoteProxyContentProvider_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweirmodule com { module sun { module star { module ucb {
28cdf0e10cSrcweir
29cdf0e10cSrcweir published interface XContentIdentifierFactory;
30cdf0e10cSrcweir published interface XContentProvider;
31cdf0e10cSrcweir published interface XParameterizedContentProvider;
32cdf0e10cSrcweir
33cdf0e10cSrcweir//============================================================================
34cdf0e10cSrcweir/** A <type>ContentProvider</type> that wraps remote content providers that
35cdf0e10cSrcweir    (potentially) have been distributed to a UCB.
36cdf0e10cSrcweir
37cdf0e10cSrcweir    <p>Before trying to pass a request to a 'real,' underlying content provider
38cdf0e10cSrcweir    (which will most likely be a remote content provider distributed to this
39cdf0e10cSrcweir    UCB), this proxy first activates any remote content providers that have
40cdf0e10cSrcweir    been distributed here, but are still inactive (see
41cdf0e10cSrcweir    <type>RemoteContentProviderAcceptor</type> and
42cdf0e10cSrcweir    <type>XRemoteContentProviderActivator</type> for more information).
43cdf0e10cSrcweir
44cdf0e10cSrcweir    <p>The way this works might change, therefore this interface is marked as
45*9c9d9658SJohn Bampton    deprecated.
46cdf0e10cSrcweir
47cdf0e10cSrcweir    @deprecated
48cdf0e10cSrcweir */
49cdf0e10cSrcweirpublished service RemoteProxyContentProvider
50cdf0e10cSrcweir{
51cdf0e10cSrcweir    //------------------------------------------------------------------------
52cdf0e10cSrcweir    /** activates any potentially inactive remote content providers before
53cdf0e10cSrcweir        passing on requests to the underlying <type>XContentProvider</type>.
54cdf0e10cSrcweir     */
55cdf0e10cSrcweir    interface XContentProvider;
56cdf0e10cSrcweir
57cdf0e10cSrcweir    //------------------------------------------------------------------------
58cdf0e10cSrcweir    /** activates any potentially inactive remote content providers before
59cdf0e10cSrcweir        passing on requests to the underlying
60cdf0e10cSrcweir        <type>XContentIdentifierFactory</type>.
61cdf0e10cSrcweir     */
62cdf0e10cSrcweir    [optional] interface XContentIdentifierFactory;
63cdf0e10cSrcweir
64cdf0e10cSrcweir    //------------------------------------------------------------------------
65cdf0e10cSrcweir    /** allows this <type>ContentProvider</type> to adjust itself to special
66cdf0e10cSrcweir        needs.
67cdf0e10cSrcweir     */
68cdf0e10cSrcweir    [optional] interface XParameterizedContentProvider;
69cdf0e10cSrcweir};
70cdf0e10cSrcweir
71cdf0e10cSrcweir}; }; }; };
72cdf0e10cSrcweir
73cdf0e10cSrcweir#endif
74