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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_configuration_backend_XSchemaHandler_idl__
#define __com_sun_star_configuration_backend_XSchemaHandler_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/configuration/backend/TemplateIdentifier.idl>
#include <com/sun/star/configuration/backend/MalformedDataException.idl>
#include <com/sun/star/lang/WrappedTargetException.idl>
module com { module sun { module star { module configuration { module backend {
/** receives a description of a configuration schema as a sequence of events.
@since OOo 1.1.2
*/
published interface XSchemaHandler: ::com::sun::star::uno::XInterface
{
/** receives notification that a schema description is started.
<p> The schema description may comprise components templates or both.
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
if a schema is already started (and has not been ended).
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
void startSchema( )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that the current schema description is complete.
<p> Must match a previous call to startSchema().
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if invalid data is detected in the schema</li>
<li>if there is a unfinished component or template in progress</li>
<li>if no schema is started at all</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
void endSchema( )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that the schema depends on templates
from a different component.
@param aName
specifies the name of the component.
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there is a unfinished component or template in progress</li>
<li>if no schema is started at all</li>
<li>if the name is not a valid component name</li>
<li>if the requested component is not found</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
void importComponent( [in] string aName )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a component description is started.
<p> Subsequent calls describe the schema of the component
until a matching call to endComponent()
is encountered.
</p>
@param aName
specifies the name of the component.
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there is a unfinished component or template in progress </li>
<li>if no schema is started at all </li>
<li>if there already is a component data tree of this name</li>
<li>if the name is not a valid component name</li>
<li>if the instance supports no component schemas (only templates)</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
void startComponent( [in] string aName )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a component description is complete.
<p> Must match a previous call to startComponent().
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if invalid data is detected in the component<li>
<li>if there is a unfinished subnode in progress<li>
<li>if no component has been started at all<li>
<li>if the instance supports no component schemas (only templates)<li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
void endComponent( )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a template description is started for a group.
<p> Subsequent calls describe the members and properties of the template
until a matching call to endTemplate()
is encountered.
</p>
@param aTemplate
specifies the identity of the template.
@param aAttributes
specifies the attributes of the template.
<p> The value is a combination of
SchemaAttribute flags.
</p>
<p> SchemaAttribute::EXTENSIBLE can be used
to describe a template for a node with an extensible
set of properties.
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there is a unfinished component or template in progress</li>
<li>if no schema is started at all </li>
<li>if there already is a template with that identifier</li>
<li>if the name is not a valid template identifier </li>
<li>if the attributes are not valid for a group</li>
<li>if the instance supports no templates (only component schemas)</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
@see com::sun::star::configuration::backend::SchemaAttribute
*/
void startGroupTemplate( [in] TemplateIdentifier aTemplate,
[in] short aAttributes )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a template description is started for a set.
<p> Subsequent calls describe the members and properties of the template
until a matching call to endTemplate()
is encountered.
</p>
@param aTemplate
specifies the identity of the template.
@param aAttributes
specifies the attributes of the template.
<p> The value is a combination of
SchemaAttribute flags.
</p>
<p> SchemaAttribute::EXTENSIBLE can be used
to describe a template for a node with an extensible
set of properties.
</p>
@param aItemType
specifies the (default) template for set items.
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there is a unfinished component or template in progress</li>
<li>if no schema is started at all </li>
<li>if there already is a template with that identifier</li>
<li>if the item-type template is not found</li>
<li>if the name or item-type are not valid template identifiers </li>
<li>if the attributes are not valid for a set</li>
<li>if the instance supports no templates (only component schemas).</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
@see com::sun::star::configuration::backend::SchemaAttribute
*/
void startSetTemplate( [in] TemplateIdentifier aTemplate,
[in] short aAttributes,
[in] TemplateIdentifier aItemType )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a template description is complete.
<p> Must match a previous call to startGroupTemplate()
or startSetTemplate().
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if invalid data is detected in the template</li>
<li>if there is a unfinished subnode in progress</li>
<li>if no template has been started at all</li>
<li>if the instance supports no templates (only component schemas)</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
void endTemplate( )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a group description is started.
<p> Subsequent calls describe the members and properties of the group
until a matching call to endNode()
is encountered.
</p>
@param aName
specifies the name of the group.
@param aAttributes
specifies the attributes of the node.
<p> The value is a combination of
SchemaAttribute flags.
</p>
<p> SchemaAttribute::EXTENSIBLE can be used
to describe a group with an extensible set of properties.
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't a group node in progress currently</li>
<li>if there already is a node with that name</li>
<li>if the name is not a valid node name</li>
<li>if the attributes are not valid for a group</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
@see com::sun::star::configuration::backend::SchemaAttribute
*/
void startGroup( [in] string aName,
[in] short aAttributes )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a set description is started.
<p> Subsequent calls describe the item-types and properties of the set
until a matching call to endNode()
is encountered.
</p>
@param aName
specifies the name of the set.
@param aAttributes
specifies the attributes of the node.
<p> The value is a combination of
SchemaAttribute flags.
</p>
<p> SchemaAttribute::EXTENSIBLE can be used
to describe a set with an extensible set of properties.
</p>
@param aItemType
specifies the (default) template for set items.
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't a group node in progress currently</li>
<li>if there already is a node with that name</li>
<li>if the item-type template is not found</li>
<li>if the name is not a valid node name</li>
<li>if the item-type is not a valid template identifier</li>
<li>if the attributes are not valid for a set</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
@see com::sun::star::configuration::backend::SchemaAttribute
*/
void startSet( [in] string aName,
[in] short aAttributes,
[in] TemplateIdentifier aItemType )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a node description is complete.
<p> Must match the last open call to startGroup()
or startSet().
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if the name is not a the name of the node in progress</li>
<li>if invalid data is detected in the node</li>
<li>if no node has been started at all</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
void endNode( )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a property is added to the current node.
<p> The property will have a default value of `NULL`
(unless it is SchemaAttribute::REQUIRED).
</p>
@param aName
specifies the name of the new property.
@param aAttributes
specifies the attributes of the new property.
<p> The value is a combination of
SchemaAttribute flags.
</p>
@param aType
specifies the type of the new property.
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't a group or extensible node in progress currently</li>
<li>if a property with the same name already exists</li>
<li>if the specified type is not allowed</li>
<li>if the name is not a valid property name</li>
<li>if the attributes are not valid for a property</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
@see com::sun::star::configuration::backend::SchemaAttribute
*/
void addProperty( [in] string aName,
[in] short aAttributes,
[in] type aType )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that a property having a default value
is added to the current node.
@param aName
specifies the name of the new property.
@param aAttributes
specifies the attributes of the new property.
<p> The value is a combination of
SchemaAttribute flags.
</p>
@param aDefaultValue
specifies the value of the new property.
<p> The value also determines the type.
Therefore the value must not be `VOID`.
</p>
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't a group or extensible node in progress currently</li>
<li>if a property with the same name already exists</li>
<li>if the type of the default value is not an allowed type,
or if the default value is `VOID`</li>
<li>if the name is not a valid property name</li>
<li>if the attributes are not valid for a property</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
@see com::sun::star::configuration::backend::SchemaAttribute
*/
void addPropertyWithDefault( [in] string aName,
[in] short aAttributes,
[in] any aDefaultValue )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that the current group has a child node
that is an instance of a specified template.
@param aName
specifies the name of the new node.
@param aTemplate
specifies a template that describes the new node.
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't a group node in progress currently</li>
<li>if there already is a node with that name</li>
<li>if the template is not found</li>
<li>if the name or template name are not valid</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
void addInstance( [in] string aName,
[in] TemplateIdentifier aTemplate )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
/** receives notification that the current set can contain items
that are instances of a specified template.
@param aItemType
specifies a template that is accepted as valid item type
for the current set node.
@throws com::sun::star::configuration::backend::MalformedDataException
<ul>
<li>if there isn't a set node in progress currently</li>
<li>if the template is not found</li>
<li>if the name is not a valid template name</li>
</ul>
<p><em>Not every implementation can detect each condition</em></p>
@throws com::sun::star::lang::WrappedTargetException
if an error occurs processing the event.
*/
void addItemType( [in] TemplateIdentifier aItemType )
raises( MalformedDataException,
com::sun::star::lang::WrappedTargetException );
};
}; }; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
