blob: 2bcefd070ac3320bfb6e7c8b4033bd59a610849d (
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
|
/*************************************************************************
*
* 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_configuration_backend_XVersionedSchemaSupplier_idl__
#define __com_sun_star_configuration_backend_XVersionedSchemaSupplier_idl__
#ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__
#include <com/sun/star/configuration/backend/XSchemaSupplier.idl>
#endif
#ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__
#include <com/sun/star/configuration/backend/BackendAccessException.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
//=============================================================================
module com { module sun { module star { module configuration { module backend {
//=============================================================================
/**
provides access to versioned configuration component schemas.
@since OOo 2.0
*/
interface XVersionedSchemaSupplier : XSchemaSupplier
{
//-------------------------------------------------------------------------
/**
Returns the schema version for a particular component.
@param aComponent
component whose schema version will be determined
@returns
a <atom>string</atom> that identifies the schema version for
the given component.
<p> The format of the version string is arbitrary. No meaning
should be attached to it, unless an implementing service
defines one. If no version can be determined, an empty
<atom>string</atom> may be returned.
</p>
<p> Clients may assume that all instances of a schema with the
same version are identical. The converse is not true.
In particular an implementation may return the same version
string for all schemas it supplies (i.e. return a version for
the complete schema, including all components)
</p>
@throws com::sun::star::lang::IllegalArgumentException
if the component identifier is invalid.
@throws com::sun::star::configuration::backend::BackendAccessException
if an error occurs while accessing the version data.
*/
string getSchemaVersion([in] string aComponent)
raises (BackendAccessException,
com::sun::star::lang::IllegalArgumentException) ;
//-------------------------------------------------------------------------
} ;
//=============================================================================
} ; } ; } ; } ; } ;
#endif
|
