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_LayerUpdateMerger_idl__
28#define __com_sun_star_configuration_backend_LayerUpdateMerger_idl__
29
30#ifndef __com_sun_star_lang_XInitialization_idl__
31#include <com/sun/star/lang/XInitialization.idl>
32#endif
33
34#ifndef __com_sun_star_configuration_backend_XUpdateHandler_idl__
35#include <com/sun/star/configuration/backend/XUpdateHandler.idl>
36#endif
37
38//=============================================================================
39
40module com { module sun { module star { module configuration { module backend {
41
42//=============================================================================
43
44/**
45    applies updates to a configuration layer.
46
47    <p> The configuration layer data is read from a <type>XLayer</type>
48    and the changed layer is provided as <type>XLayer</type> again or
49    described to a <type>XLayerHandler</type>.
50    </p>
51
52    @see com::sun::star::configuration::backend::UpdatableLayer
53        Service describes a layer and accepts a changed layer..
54
55    @since OOo 1.1.2
56*/
57published service LayerUpdateMerger
58{
59	//-------------------------------------------------------------------------
60
61    /** accepts events describing the changes.
62      */
63    interface com::sun::star::configuration::backend::XUpdateHandler ;
64
65	//-------------------------------------------------------------------------
66
67    /** allows initializing layer data source and target.
68
69        <p> Both source and target of the update can be provided by passing a
70            <type>XUpdatableLayer</type> object. Alternatively they can be
71            provided individually by providing a <type>XLayer</type> object as
72            data source and an <type>XLayerHandler</type> object to receive the
73            updated data.
74        </p>
75        <p> Implementations can provide more arguments to finetune the behavior.
76            Such arguments are provided as
77            <type scope="com::sun::star::beans">NamedValue</type>.
78            Implementations should support the following named arguments:
79        <dl>
80            <dt><code>Overwrite</code> : <atom>boolean</atom></dt>
81            <dd>If <FALSE/>, specifies that changes should be applied
82                only if the existing layer is empty.
83            </dd>
84            <dt><code>Truncate</code> : <atom>boolean</atom></dt>
85            <dd>If <TRUE/> requests that changes should not be merged onto
86                existing data, but that the changes should be applied
87                to a layer that is completely empty.
88            </dd>
89        </dl>
90        </p>
91      */
92    interface com::sun::star::lang::XInitialization ;
93
94	//-------------------------------------------------------------------------
95} ;
96
97//=============================================================================
98
99} ; } ; } ; } ; } ;
100
101#endif
102