blob: 562508a74314e834b856328a6fa3d2dc08802f3e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_ucb_UniversalContentBroker_idl__
#define __com_sun_star_ucb_UniversalContentBroker_idl__
#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif
#ifndef __com_sun_star_ucb_XCommandProcessor_idl__
#include <com/sun/star/ucb/XCommandProcessor.idl>
#endif
#ifndef __com_sun_star_ucb_XCommandProcessor2_idl__
#include <com/sun/star/ucb/XCommandProcessor2.idl>
#endif
#ifndef __com_sun_star_ucb_XContentProviderManager_idl__
#include <com/sun/star/ucb/XContentProviderManager.idl>
#endif
#ifndef __com_sun_star_ucb_XContentProvider_idl__
#include <com/sun/star/ucb/XContentProvider.idl>
#endif
#ifndef __com_sun_star_ucb_XContentIdentifierFactory_idl__
#include <com/sun/star/ucb/XContentIdentifierFactory.idl>
#endif
#ifndef __com_sun_star_lang_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.idl>
#endif
//=============================================================================
module com { module sun { module star { module ucb {
//=============================================================================
/** is a one-instance service that provides access to a set of
<type>Content</type>s via <type>ContentProvider</type>s.
<p>If the instance is created with two arguments of type string,
these two strings are used to configure the newly instantiated broker;
see the description of the required
<type scope="com::sun::star::lang">XInitialization</type> interface for
details.
<p>If the instance is created without arguments, the newly instatiated
broker is not configured.
*/
published service UniversalContentBroker
{
//-------------------------------------------------------------------------
/** must be implemented to make it possible to resolve cyclic object
references.
<p>Those references i.e. may occure if content provider implementations
hold references to the Broker. The Broker itself always holds its
providers. If the Broker shall be released,
<member scope="com::sun::star::lang">XComponent::dispose</member>
must be called at the Broker. The implementation of this method must
call
<member scope="com::sun::star::lang">XEventListener::disposing</member>
on the registered listeners (the providers holding the Broker must be
those listeners) and release the appropriate object references. At
the other hand, the implementation of XEventListener::disposing must
release its appropriate references.
<p>This interface is required.
*/
interface com::sun::star::lang::XComponent;
//-------------------------------------------------------------------------
/** provides access to all kind of contents provided by the registered
content providers.
<p>This interface is required.
*/
interface com::sun::star::ucb::XContentProvider;
//-------------------------------------------------------------------------
/** provides access to a set of content providers registered with the UCB.
<p>This interface is required.
*/
interface com::sun::star::ucb::XContentProviderManager;
//-------------------------------------------------------------------------
/** creates <type>XContentIdentifier</type> implementation objects for
all kind of contents provided by the UCB.
<p>This interface is required.
*/
interface com::sun::star::ucb::XContentIdentifierFactory;
//-------------------------------------------------------------------------
/** supports the configuration of a newly created broker.
<p>The
<member scope="com::sun::star::lang">XInitialization::initialize</member>
method should be called with two arguments of type string. These strings
are used as a pair of keys to retrieve a set of content provider
descriptions from the configuration management (stored at
<code>org.openoffice.ucb.Configuration.ContentProviders.<var>key<sub>1</sub></var>.SecondaryKeys.<var>key<sub>2</sub></var>.ProviderData</code>
within the configuration management's hierarchy). The retrieved
descriptions are in turn used to register the corresponding content
provider services at the broker.
<p>Typical values for the pair of strings would be
<code>"Local"</code>/<code>"Office"</code>, to configure a broker that
contains all the relevant content providers.
<p>This interface is required.
*/
interface com::sun::star::lang::XInitialization;
//-------------------------------------------------------------------------
/** enables the caller to execute commands at the broker.
<p>This interface is required.
<p><pre>
=======================================================================
Commands:
=======================================================================
[return type]
[command name]
[parameter type and name]
-----------------------------------------------------------------------
Requiered commands:
-----------------------------------------------------------------------
// This command obtains an interface which allows to query
// information on commands supported by the Content Broker.
<type>XCommandInfo</type>
getCommandInfo
void
// This command transfers Contents from one location to another.
// Additionally, it can be used to create a link to a Content.
// The implementation must be able to handle Contents provided
// by any Content Provider. This is different from the command
// 'transfer' that can be supported by a Content. That command
// typically can only handle <type>Content</type>s provided by one
// <type>ContentProvider</type>.
void
globalTransfer
<type>GlobalTransferCommandArgument</type>
</pre>
*/
interface com::sun::star::ucb::XCommandProcessor;
//-------------------------------------------------------------------------
/** is an enhanced version of <type>XCommandProcessor</type> that has an
additional method for releasing command identifiers obtained via
<member>XCommandProcessor::createCommandIdentifier</member> to avoid
resource leaks. For a detailed description of the problem refer to
<member>XCommandProcessor2::releaseCommandIdentifier</member>.
<p>Where many existing <type>UniversalContentBroker</type>
implementations do not (yet), every new implementation should support
this interface.
*/
[optional] interface com::sun::star::ucb::XCommandProcessor2;
};
//=============================================================================
}; }; }; };
#endif
|
