offapi/com/sun/star/configuration/backend/LocalDataImporter.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: LocalDataImporter.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_LocalDataImporter_idl__
  31 #define __com_sun_star_configuration_backend_LocalDataImporter_idl__
  32
  33 #ifndef __com_sun_star_configuration_backend_DataImporter_idl__
  34 #include <com/sun/star/configuration/backend/DataImporter.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module configuration { module backend {
  40
  41 //=============================================================================
  42
  43 /**
  44     allows importing data from a local configuration data repository
  45     or file into any <type>Backend</type>.
  46
  47     <p> Data to be imported can be a single layer either from a full local
  48         configuration database or from a particular OOR Update XML file.
  49     </p>
  50     <p> Data is imported into the <type>DefaultBackend</type>.
  51     </p>
  52
  53     @see com::sun::star::configuration::backend::LocalHierarchyBrowser
  54         Service that can be used to locate available layer files or components.
  55
  56     @see com::sun::star::configuration::backend::LocalSingleBackend
  57         Service that can be used to access a local configuration database.
  58
  59     @since OOo 1.1.2
  60 */
  61 published service LocalDataImporter
  62 {
  63     //-------------------------------------------------------------------------
  64
  65     /** provides for running an import job
  66
  67         <p> The implementation returns <void/> from
  68             <member scope="com::sun::star::task">XJob::execute()</member>
  69             to indicates successful execution. If import is not executed,
  70             because <code>OverwriteExisting = </code><TRUE/> was specified,
  71             a <type scope="com::sun::star::lang">IllegalAccessException</type>
  72             is returned.
  73         </p>
  74          <p>If <void/> or <TRUE/> is returned, this indicates successful
  75             execution. If an
  76             <type scope="com::sun::star::uno">Exception</type> is returned,
  77             it represents an error condition encountered during execution.
  78         </p>
  79
  80         <p> The standard arguments to
  81             <member scope="com::sun::star::task">XJob::execute()</member>
  82             are all supported by implementations. Additionally the following
  83             argument is required to select the data source:
  84         <dl>
  85             <dt><code>LayerDataUrl</code> : <atom >string</atom></dt>
  86             <dd>A file URL that specifies the location of the source data.
  87                 <p> If no <code>Component</code> is provided, this must be the
  88                     location of an OOR Update XML file, which will be imported
  89                     directly.
  90                 </p>
  91                 <p> If a <code>Component</code> is provided, the
  92                     <code>LayerDataUrl</code> is treated as Entity
  93                     (i.e. Layer directory base URL) for a local
  94                     configuration database and the appropriate component
  95                     from that repository is imported.
  96                 </p>
  97             </dd>
  98         </dl>
  99         </p>
 100         <p> Implementations may support additional parameters to select
 101             a destination <type>Backend</type>, that is not the
 102             <type>DefaultBackend</type>.
 103         </p>
 104       */
 105     service DataImporter ;
 106
 107     //-------------------------------------------------------------------------
 108 } ;
 109
 110 //=============================================================================
 111
 112 } ; } ; } ; } ; } ;
 113
 114 #endif