summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/configuration/backend/CopyImporter.idl
blob: ab790ba521e1f9e2bf90943f569a010947b03b44 (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
/*************************************************************************
 *
 * 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_CopyImporter_idl__
#define __com_sun_star_configuration_backend_CopyImporter_idl__

#ifndef __com_sun_star_configuration_backend_Importer_idl__
#include <com/sun/star/configuration/backend/Importer.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 {

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

/**
    imports data into a configuration layer by copying over existing data.


    @since OOo 1.1.2
*/
published service CopyImporter
{
    //-------------------------------------------------------------------------

    /** allows importing configuration data into a backend.

        <p> In this implementation, the changes are copied over any
            <type>XLayer</type> data that already exists in the <type>Backend</type>,
            replacing it completely.
        </p>
      */
    service Importer ;

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

    /** allows initializing the implementation with settings that control
        its behavior .

        <p> This interface, which is optional in <type>Importer</type>
            is mandatory in this service and supports the following arguments
            which must be provided as
            <type scope="com::sun::star::beans">NamedValue</type>:
        <dl>
            <dt><code>Overwrite</code> : <atom>boolean</atom></dt>
            <dd>If <FALSE/>, specifies that the data should be applied
                only if the existing layer is empty.
            </dd>
        </dl>
        </p>
      */
    interface com::sun::star::lang::XInitialization ;

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

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

} ; } ; } ; } ; } ;

#endif