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