summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/configuration/backend/XUpdatableLayer.idl
blob: 7b3a9128df2270d3759868390ce503f9f4ea3ab2 (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
/*************************************************************************
 *
 * 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: XUpdatableLayer.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_XUpdatableLayer_idl__
#define __com_sun_star_configuration_backend_XUpdatableLayer_idl__

#ifndef __com_sun_star_configuration_backend_XLayer_idl__
#include <com/sun/star/configuration/backend/XLayer.idl>
#endif

#ifndef __com_sun_star_lang_NullPointerException_idl__
#include <com/sun/star/lang/NullPointerException.idl>
#endif 

#ifndef __com_sun_star_lang_WrappedTargetException_idl__
#include <com/sun/star/lang/WrappedTargetException.idl>
#endif 

#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
#include <com/sun/star/configuration/backend/MalformedDataException.idl>
#endif

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

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

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

/**
  Provides access to a read-write layer of configuration data for
  a given component and entity.

    @since OOo 1.1.2
  */
published interface XUpdatableLayer : XLayer 
{
    //--------------------------------------------------------------------------

    /**
       Replaces the current layer with the layer given as input
       parameter.

       <p> After the replacement has been performed, reading the
           layer will return the new content. Some implementations 
           may not support this, so after an update
           <member>XLayer::readData()</member> may fail.
        </p>

       @param aNewLayer 
               replacement layer

       @throws com::sun::star::lang::NullPointerException
               if a <NULL/> handler is passed.
       @throws com::sun::star::lang::WrappedTargetException
               if an error occurs during the replacement.
       @throws com::sun::star::configuration::backend::MalformedDataException
               if the layer contains invalid data.
     */
    void replaceWith([in] XLayer aNewLayer) 
        raises (com::sun::star::lang::NullPointerException,
                com::sun::star::lang::WrappedTargetException,
                MalformedDataException) ;

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

} ; } ; } ; } ; } ;
#endif