1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_configuration_backend_XVersionedSchemaSupplier_idl__
24#define __com_sun_star_configuration_backend_XVersionedSchemaSupplier_idl__
25
26#ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__
27#include <com/sun/star/configuration/backend/XSchemaSupplier.idl>
28#endif
29
30#ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__
31#include <com/sun/star/configuration/backend/BackendAccessException.idl>
32#endif
33
34#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
35#include <com/sun/star/lang/IllegalArgumentException.idl>
36#endif
37
38//=============================================================================
39
40module com { module sun { module star { module configuration { module backend {
41
42//=============================================================================
43
44/**
45  provides access to versioned configuration component schemas.
46
47  @since OOo 2.0
48*/
49interface XVersionedSchemaSupplier : XSchemaSupplier
50{
51	//-------------------------------------------------------------------------
52
53    /**
54      Returns the schema version for a particular component.
55
56      @param aComponent
57                component whose schema version will be determined
58
59      @returns
60                a <atom>string</atom> that identifies the schema version for
61                the given component.
62
63                <p> The format of the version string is arbitrary. No meaning
64                should be attached to it, unless an implementing service
65                defines one. If no version can be determined, an empty
66                <atom>string</atom> may be returned.
67                </p>
68
69                <p> Clients may assume that all instances of a schema with the
70                same version are identical. The converse is not true.
71                In particular an implementation may return the same version
72                string for all schemas it supplies (i.e. return a version for
73                the complete schema, including all components)
74                </p>
75
76      @throws   com::sun::star::lang::IllegalArgumentException
77                if the component identifier is invalid.
78
79      @throws   com::sun::star::configuration::backend::BackendAccessException
80                if an error occurs while accessing the version data.
81	*/
82    string getSchemaVersion([in] string aComponent)
83        raises (BackendAccessException,
84                com::sun::star::lang::IllegalArgumentException) ;
85
86	//-------------------------------------------------------------------------
87} ;
88
89//=============================================================================
90
91} ; } ; } ; } ; } ;
92
93#endif
94