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
28#ifndef __com_sun_star_configuration_backend_XUpdatableLayer_idl__
29#define __com_sun_star_configuration_backend_XUpdatableLayer_idl__
30
31#ifndef __com_sun_star_configuration_backend_XLayer_idl__
32#include <com/sun/star/configuration/backend/XLayer.idl>
33#endif
34
35#ifndef __com_sun_star_lang_NullPointerException_idl__
36#include <com/sun/star/lang/NullPointerException.idl>
37#endif
38
39#ifndef __com_sun_star_lang_WrappedTargetException_idl__
40#include <com/sun/star/lang/WrappedTargetException.idl>
41#endif
42
43#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
44#include <com/sun/star/configuration/backend/MalformedDataException.idl>
45#endif
46
47//==============================================================================
48
49module com { module sun { module star { module configuration { module backend {
50
51//==============================================================================
52
53/**
54  Provides access to a read-write layer of configuration data for
55  a given component and entity.
56
57    @since OOo 1.1.2
58  */
59published interface XUpdatableLayer : XLayer
60{
61    //--------------------------------------------------------------------------
62
63	/**
64	   Replaces the current layer with the layer given as input
65	   parameter.
66
67       <p> After the replacement has been performed, reading the
68           layer will return the new content. Some implementations
69           may not support this, so after an update
70           <member>XLayer::readData()</member> may fail.
71        </p>
72
73       @param aNewLayer
74               replacement layer
75
76       @throws com::sun::star::lang::NullPointerException
77               if a <NULL/> handler is passed.
78       @throws com::sun::star::lang::WrappedTargetException
79               if an error occurs during the replacement.
80       @throws com::sun::star::configuration::backend::MalformedDataException
81               if the layer contains invalid data.
82	 */
83	void replaceWith([in] XLayer aNewLayer)
84        raises (com::sun::star::lang::NullPointerException,
85                com::sun::star::lang::WrappedTargetException,
86                MalformedDataException) ;
87
88    //--------------------------------------------------------------------------
89} ;
90
91} ; } ; } ; } ; } ;
92#endif
93