summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/configuration/backend/BackendAdapter.idl
blob: dfb881b76bf0a22caad6eb5fa1aced4b814139f4 (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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_BackendAdapter_idl__
#define __com_sun_star_configuration_backend_BackendAdapter_idl__

#ifndef __com_sun_star_configuration_backend_Backend_idl__
#include <com/sun/star/configuration/backend/Backend.idl>
#endif 

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

#ifndef __com_sun_star_lang_XInitialization_idl__
#include <com/sun/star/lang/XInitialization.idl>
#endif 

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

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

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

/**
    implements <type>Backend</type> retrieving data 
    from a <type>SingleBackend</type>.
  
    @since OOo 1.1.2
*/
published service BackendAdapter
{
    //------------------------------------------------------------------------- 

    /** provides access to configuration data.
      */
    service Backend ;

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

    /**
      This interface, that is optional in <type>Backend</type>, is
      mandatory in this service.
      */
    interface XBackendEntities ;

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

    /**
      allows initializing the backend to use.

      <p>If this interface is present, a <type>SingleBackend</type>
        may be passed, that is used to access the data. 
        Also a <type scope="com::sun::star::configuration::bootstrap">BootstrapContext</type> 
        can be passed, that provides further settings for the backend.
      </p>

      <p>If this interface is missing, the real backend to use is determined 
        from the <type scope="com::sun::star::uno">XComponentContext</type>.
      </p>
      */
    [optional] interface com::sun::star::lang::XInitialization ;

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

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

} ; } ; } ; } ; } ; 

#endif