offapi/com/sun/star/configuration/backend/CopyImporter.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: CopyImporter.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 #ifndef __com_sun_star_configuration_backend_CopyImporter_idl__
  31 #define __com_sun_star_configuration_backend_CopyImporter_idl__
  32
  33 #ifndef __com_sun_star_configuration_backend_Importer_idl__
  34 #include <com/sun/star/configuration/backend/Importer.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_XInitialization_idl__
  38 #include <com/sun/star/lang/XInitialization.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module configuration { module backend {
  44
  45 //=============================================================================
  46
  47 /**
  48     imports data into a configuration layer by copying over existing data.
  49
  50
  51     @since OOo 1.1.2
  52 */
  53 published service CopyImporter
  54 {
  55     //-------------------------------------------------------------------------
  56
  57     /** allows importing configuration data into a backend.
  58
  59         <p> In this implementation, the changes are copied over any
  60             <type>XLayer</type> data that already exists in the <type>Backend</type>,
  61             replacing it completely.
  62         </p>
  63       */
  64     service Importer ;
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** allows initializing the implementation with settings that control
  69         its behavior .
  70
  71         <p> This interface, which is optional in <type>Importer</type>
  72             is mandatory in this service and supports the following arguments
  73             which must be provided as
  74             <type scope="com::sun::star::beans">NamedValue</type>:
  75         <dl>
  76             <dt><code>Overwrite</code> : <atom>boolean</atom></dt>
  77             <dd>If <FALSE/>, specifies that the data should be applied
  78                 only if the existing layer is empty.
  79             </dd>
  80         </dl>
  81         </p>
  82       */
  83     interface com::sun::star::lang::XInitialization ;
  84
  85     //-------------------------------------------------------------------------
  86 } ;
  87
  88 //=============================================================================
  89
  90 } ; } ; } ; } ; } ;
  91
  92 #endif