offapi/com/sun/star/configuration/backend/Importer.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: Importer.idl,v $
  10  * $Revision: 1.7 $
  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_Importer_idl__
  31 #define __com_sun_star_configuration_backend_Importer_idl__
  32
  33 #ifndef __com_sun_star_lang_XInitialization_idl__
  34 #include <com/sun/star/lang/XInitialization.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_configuration_backend_XLayerImporter_idl__
  38 #include <com/sun/star/configuration/backend/XLayerImporter.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.
  49
  50     <p> The configuration changes are read from a <type>XLayer</type>
  51         and stored into a <type>Backend</type>.
  52     </p>
  53
  54     @since OOo 1.1.2
  55 */
  56 published service Importer
  57 {
  58     //-------------------------------------------------------------------------
  59
  60     /** allows importing configuration data into a backend.
  61       */
  62     interface XLayerImporter ;
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** allows initializing the implementation with settings that control
  67         its behavior .
  68
  69         <p> Arguments are provided as
  70             <type scope="com::sun::star::beans">NamedValue</type>.
  71             Implementations specify which arguments they support.
  72
  73         <dl>
  74             <dt><code>Notify</code> : <atom>boolean</atom></dt>
  75             <dd>If <TRUE/>, specifies that the backend should trigger
  76              notification to its listeners.
  77             </dd>
  78         </dl>
  79         </p>
  80     */
  81     [optional] interface com::sun::star::lang::XInitialization ;
  82
  83     //-------------------------------------------------------------------------
  84 } ;
  85
  86 //=============================================================================
  87
  88 } ; } ; } ; } ; } ;
  89
  90 #endif