summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/configuration/backend/Backend.idl
blob: fc16defa4d58cbad8769d838cefe842cf1733341 (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
98
99
100
101
102
103
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: Backend.idl,v $
 * $Revision: 1.6 $
 *
 * 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_Backend_idl__
#define __com_sun_star_configuration_backend_Backend_idl__

#ifndef __com_sun_star_configuration_backend_XBackend_idl__
#include <com/sun/star/configuration/backend/XBackend.idl>
#endif 

#ifndef __com_sun_star_configuration_backend_XBackendEntities_idl__
#include <com/sun/star/configuration/backend/XBackendEntities.idl>
#endif 

#ifndef __com_sun_star_configuration_backend_XSchemaSupplier_idl__
#include <com/sun/star/configuration/backend/XSchemaSupplier.idl>
#endif 

//============================================================================= 

module com { module sun { module star { module configuration { module backend {

//============================================================================= 

/**
    provides access to a configuration database composed of one or more 
    storage backends containing settings used by software modules.

    <p> Configuration data is organized into layers which are selected 
        by components and entities. 
    </p>

    <p> Components are characterized by configuration schemas. 
        A component contains configuration data for a particular 
        application domain or software module.
    </p>
    <p> Entities are organised hierarchically in organisations,
        groups, roles and individual users. Each element of the associated 
        hierarchy corresponds to a layer that applies to an entity.
    </p>
    <p> A layer contains data for multiple components 
        associated to a single entity.
    <p>
  
    @since OOo 1.1.2
*/
published service Backend 
{
    //------------------------------------------------------------------------- 

    /**
      provides access to configuration schemas.
      */
    interface XSchemaSupplier ;

    //------------------------------------------------------------------------- 

    /**
      provides access to the layer data.
      */
    interface XBackend ;

    //------------------------------------------------------------------------- 

    /**
      provides information about supported and special entities.
      */
    [optional] interface XBackendEntities ;

    //------------------------------------------------------------------------- 
} ;

//============================================================================= 

} ; } ; } ; } ; } ; 

#endif