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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
|
/*************************************************************************
*
* 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_embed_XRelationshipAccess_idl__
#define __com_sun_star_embed_XRelationshipAccess_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_beans_StringPair_idl__
#include <com/sun/star/beans/StringPair.idl>
#endif
#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#endif
#ifndef __com_sun_star_container_ElementExistException_idl__
#include <com/sun/star/container/ElementExistException.idl>
#endif
#ifndef __com_sun_star_io_IOException_idl__
#include <com/sun/star/io/IOException.idl>
#endif
//============================================================================
module com { module sun { module star { module embed {
//============================================================================
/** This interface allows to get access to relationship data.
<p>
The relationship data is organized as a set of entries. Each of entry
is represented by a set of tags, where each tag has unique for this entry
name and a string value. An entry must contain at least one tag named
"ID", the value of this tag must be unique for the whole set of entries,
this tag is used as a unique identifier of an entry.
</p>
*/
published interface XRelationshipAccess : ::com::sun::star::uno::XInterface
{
// -----------------------------------------------------------------------
/** allows to detect whether there is an entry with specified value of
"ID" tag.
@param sID
the value of "ID" tag
@throws ::com::sun::star::io::IOException
in case there is a problem reading the relations info
*/
boolean hasByID( [in] string sID )
raises( ::com::sun::star::io::IOException );
// -----------------------------------------------------------------------
/** retrieves the value of "Target" tag from the entry with specified "ID"
tag.
<p>
If the entry has no "Target" tag an empty string is returned.
</p>
@param sID
the value of "ID" tag
@throws ::com::sun::star::container::NoSuchElementException
in case there is no entry with specified tag
@throws ::com::sun::star::io::IOException
in case there is a problem reading the relations info
*/
string getTargetByID( [in] string sID )
raises( ::com::sun::star::container::NoSuchElementException,
::com::sun::star::io::IOException );
// -----------------------------------------------------------------------
/** retrieves the value of "Type" tag from the entry with specified "ID"
tag.
<p>
If the entry has no "Type" tag an empty string is returned.
</p>
@param sID
the value of "ID" tag
@throws ::com::sun::star::container::NoSuchElementException
in case there is no entry with specified tag
@throws ::com::sun::star::io::IOException
in case there is a problem reading the relations info
*/
string getTypeByID( [in] string sID )
raises( ::com::sun::star::container::NoSuchElementException,
::com::sun::star::io::IOException );
// -----------------------------------------------------------------------
/** retrieves the sequence containing all the tags from the entry with
specified value of "ID" tag.
@param sID
the value of "ID" tag
@returns
sequence, each element of the sequence represents tag,
<type scope="::com::sun::star::beans">StringPair</type>::First
represents the tag name and
<type scope="::com::sun::star::beans">StringPair</type>::Second
represents the tag value
@throws ::com::sun::star::container::NoSuchElementException
in case there is no entry with specified tag
@throws ::com::sun::star::io::IOException
in case there is a problem reading the relations info
*/
sequence< ::com::sun::star::beans::StringPair >
getRelationshipByID( [in] string sID )
raises( ::com::sun::star::container::NoSuchElementException,
::com::sun::star::io::IOException );
// -----------------------------------------------------------------------
/** retrieves the sequence containing all the entries which "Type" tag
takes the specified value.
@param sType
specified value of "Type" tag, the parameter can contain an empty
string, in this case all the entries that have empty "Type" tag or
no such tag at all are returned
@returns
sequence of entries, each entry is represented by sequence,
each element of the sequence represents tag,
<type scope="::com::sun::star::beans">StringPair</type>::First
represents the tag name and
<type scope="::com::sun::star::beans">StringPair</type>::Second
represents the tag value.
The sequence should contain the "ID" tag.
@throws ::com::sun::star::io::IOException
in case there is a problem reading the relations info
*/
sequence< sequence< ::com::sun::star::beans::StringPair > >
getRelationshipsByType( [in] string sType )
raises( ::com::sun::star::io::IOException );
// -----------------------------------------------------------------------
/** retrieves the sequence containing all the entries controlled by the
object.
@returns
sequence of entries, each entry is represented by sequence,
each element of the sequence represents tag,
<type scope="::com::sun::star::beans">StringPair</type>::First
represents the tag name and
<type scope="::com::sun::star::beans">StringPair</type>::Second
represents the tag value
@throws ::com::sun::star::io::IOException
in case there is a problem reading the relations info
*/
sequence< sequence< ::com::sun::star::beans::StringPair > >
getAllRelationships()
raises( ::com::sun::star::io::IOException );
// -----------------------------------------------------------------------
/** allows to insert an entry.
@param sID
the value of "ID" tag
@param aEntry
a sequence, each element of the sequence represents tag,
<type scope="::com::sun::star::beans">StringPair</type>::First
represents the tag name and
<type scope="::com::sun::star::beans">StringPair</type>::Second
represents the tag value.
May not contain "ID" tag, that is already specified in previous
parameter.
@param bReplace
specifies whether the replacement of existing entry is allowed
@throws ::com::sun::star::io::IOException
in case there is a problem reading/writing the relations info
@throws ::com::sun::star::container::ElementExistException
in case an element with the specified "ID" tag exists already, and
no replacement is allowed
*/
void insertRelationshipByID(
[in] string sID,
[in] sequence< ::com::sun::star::beans::StringPair > aEntry,
[in] boolean bReplace )
raises( ::com::sun::star::container::ElementExistException,
::com::sun::star::io::IOException );
// -----------------------------------------------------------------------
/** allows to remove an entry.
@param sID
the value of "ID" tag
@throws ::com::sun::star::container::NoSuchElementException
in case there is no entry with specified tag
@throws ::com::sun::star::io::IOException
in case there is a problem reading/writing the relations info
*/
void removeRelationshipByID( [in] string sID )
raises( ::com::sun::star::container::NoSuchElementException,
::com::sun::star::io::IOException );
// -----------------------------------------------------------------------
/** allows to insert a set of entries
@param aEntries
sequence of entries, each entry is represented by sequence,
each element of the sequence represents tag,
<type scope="::com::sun::star::beans">StringPair</type>::First
represents the tag name and
<type scope="::com::sun::star::beans">StringPair</type>::Second
represents the tag value.
Each entry must contain "ID" tag.
@param bReplace
specifies whether the replacement of existing entry is allowed
@throws ::com::sun::star::container::ElementExistException
in case an element with the provided "ID" tag exists already, and
no replacement is allowed
@throws ::com::sun::star::io::IOException
in case there is a problem reading/writing the relations info
*/
void insertRelationships(
[in] sequence< sequence< ::com::sun::star::beans::StringPair > > aEntries,
[in] boolean bReplace )
raises( ::com::sun::star::container::ElementExistException,
::com::sun::star::io::IOException );
// -----------------------------------------------------------------------
/** allows to clear the set of entries.
@throws ::com::sun::star::io::IOException
in case there is a problem reading/writing the relations info
*/
void clearRelationships()
raises( ::com::sun::star::io::IOException );
};
//============================================================================
}; }; }; };
#endif
|
