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_Backend_idl__
28#define __com_sun_star_configuration_backend_Backend_idl__
29
30#ifndef __com_sun_star_configuration_backend_XBackend_idl__
31#include <com/sun/star/configuration/backend/XBackend.idl>
32#endif
33
34#ifndef __com_sun_star_configuration_backend_XBackendEntities_idl__
35#include <com/sun/star/configuration/backend/XBackendEntities.idl>
36#endif
37
38#ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__
39#include <com/sun/star/configuration/backend/XSchemaSupplier.idl>
40#endif
41
42//=============================================================================
43
44module com { module sun { module star { module configuration { module backend {
45
46//=============================================================================
47
48/**
49    provides access to a configuration database composed of one or more
50    storage backends containing settings used by software modules.
51
52    <p> Configuration data is organized into layers which are selected
53        by components and entities.
54    </p>
55
56    <p> Components are characterized by configuration schemas.
57        A component contains configuration data for a particular
58        application domain or software module.
59    </p>
60    <p> Entities are organised hierarchically in organisations,
61        groups, roles and individual users. Each element of the associated
62        hierarchy corresponds to a layer that applies to an entity.
63    </p>
64    <p> A layer contains data for multiple components
65        associated to a single entity.
66    <p>
67
68    @since OOo 1.1.2
69*/
70published service Backend
71{
72	//-------------------------------------------------------------------------
73
74    /**
75      provides access to configuration schemas.
76      */
77    interface XSchemaSupplier ;
78
79	//-------------------------------------------------------------------------
80
81    /**
82      provides access to the layer data.
83      */
84    interface XBackend ;
85
86	//-------------------------------------------------------------------------
87
88    /**
89      provides information about supported and special entities.
90      */
91    [optional] interface XBackendEntities ;
92
93	//-------------------------------------------------------------------------
94} ;
95
96//=============================================================================
97
98} ; } ; } ; } ; } ;
99
100#endif
101