1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_configuration_backend_XVersionedSchemaSupplier_idl__
28#define __com_sun_star_configuration_backend_XVersionedSchemaSupplier_idl__
29
30#ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__
31#include <com/sun/star/configuration/backend/XSchemaSupplier.idl>
32#endif
33
34#ifndef __com_sun_star_configuration_backend_BackendAccessException_idl__
35#include <com/sun/star/configuration/backend/BackendAccessException.idl>
36#endif
37
38#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
39#include <com/sun/star/lang/IllegalArgumentException.idl>
40#endif
41
42//=============================================================================
43
44module com { module sun { module star { module configuration { module backend {
45
46//=============================================================================
47
48/**
49  provides access to versioned configuration component schemas.
50
51  @since OOo 2.0
52*/
53interface XVersionedSchemaSupplier : XSchemaSupplier
54{
55	//-------------------------------------------------------------------------
56
57    /**
58      Returns the schema version for a particular component.
59
60      @param aComponent
61                component whose schema version will be determined
62
63      @returns
64                a <atom>string</atom> that identifies the schema version for
65                the given component.
66
67                <p> The format of the version string is arbitrary. No meaning
68                should be attached to it, unless an implementing service
69                defines one. If no version can be determined, an empty
70                <atom>string</atom> may be returned.
71                </p>
72
73                <p> Clients may assume that all instances of a schema with the
74                same version are identical. The converse is not true.
75                In particular an implementation may return the same version
76                string for all schemas it supplies (i.e. return a version for
77                the complete schema, including all components)
78                </p>
79
80      @throws   com::sun::star::lang::IllegalArgumentException
81                if the component identifier is invalid.
82
83      @throws   com::sun::star::configuration::backend::BackendAccessException
84                if an error occurs while accessing the version data.
85	*/
86    string getSchemaVersion([in] string aComponent)
87        raises (BackendAccessException,
88                com::sun::star::lang::IllegalArgumentException) ;
89
90	//-------------------------------------------------------------------------
91} ;
92
93//=============================================================================
94
95} ; } ; } ; } ; } ;
96
97#endif
98