offapi/com/sun/star/configuration/backend/XUpdatableLayer.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XUpdatableLayer.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_configuration_backend_XUpdatableLayer_idl__
  32 #define __com_sun_star_configuration_backend_XUpdatableLayer_idl__
  33
  34 #ifndef __com_sun_star_configuration_backend_XLayer_idl__
  35 #include <com/sun/star/configuration/backend/XLayer.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_NullPointerException_idl__
  39 #include <com/sun/star/lang/NullPointerException.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  43 #include <com/sun/star/lang/WrappedTargetException.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__
  47 #include <com/sun/star/configuration/backend/MalformedDataException.idl>
  48 #endif
  49
  50 //==============================================================================
  51
  52 module com { module sun { module star { module configuration { module backend {
  53
  54 //==============================================================================
  55
  56 /**
  57   Provides access to a read-write layer of configuration data for
  58   a given component and entity.
  59
  60     @since OOo 1.1.2
  61   */
  62 published interface XUpdatableLayer : XLayer
  63 {
  64     //--------------------------------------------------------------------------
  65
  66     /**
  67        Replaces the current layer with the layer given as input
  68        parameter.
  69
  70        <p> After the replacement has been performed, reading the
  71            layer will return the new content. Some implementations
  72            may not support this, so after an update
  73            <member>XLayer::readData()</member> may fail.
  74         </p>
  75
  76        @param aNewLayer
  77                replacement layer
  78
  79        @throws com::sun::star::lang::NullPointerException
  80                if a <NULL/> handler is passed.
  81        @throws com::sun::star::lang::WrappedTargetException
  82                if an error occurs during the replacement.
  83        @throws com::sun::star::configuration::backend::MalformedDataException
  84                if the layer contains invalid data.
  85      */
  86     void replaceWith([in] XLayer aNewLayer)
  87         raises (com::sun::star::lang::NullPointerException,
  88                 com::sun::star::lang::WrappedTargetException,
  89                 MalformedDataException) ;
  90
  91     //--------------------------------------------------------------------------
  92 } ;
  93
  94 } ; } ; } ; } ; } ;
  95 #endif