offapi/com/sun/star/configuration/backend/DataImporter.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: DataImporter.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_DataImporter_idl__
  31 #define __com_sun_star_configuration_backend_DataImporter_idl__
  32
  33 #ifndef __com_sun_star_task_XJob_idl__
  34 #include <com/sun/star/task/XJob.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 one configuration repository into another. .
  45
  46     @since OOo 1.1.2
  47 */
  48 published service DataImporter
  49 {
  50     //-------------------------------------------------------------------------
  51
  52     /** allows running an import job
  53
  54         <p> The source and destination repositories are selected by arguments
  55             passed to
  56             <member scope="com::sun::star::task">XJob::execute()</member>.
  57             The names and meanings of such arguments depend on
  58             the implementation. Each implementation must document such arguments.
  59         </p>
  60
  61         <p> Implementations may return a value from
  62             <member scope="com::sun::star::task">XJob::execute()</member>
  63             that indicates the status of job execution. The type and meaning of
  64             such status indicators depend on the implementation.
  65         </p>
  66          <p>If <void/> or <TRUE/> is returned, this indicates successful
  67             execution. If an
  68             <type scope="com::sun::star::uno">Exception</type> is returned,
  69             it represents an error condition encountered during execution.
  70         </p>
  71
  72         <p> The following arguments to
  73             <member scope="com::sun::star::task">XJob::execute()</member>
  74             should be supported by implementations. Implementations must document
  75             a failure to support any of these arguments:
  76         <dl>
  77             <dt><code>ImporterService</code> : <atom >string</atom></dt>
  78             <dd>A service or implementation name used to instantiate the
  79                 <type>Importer</type> to use for importing. If this parameter
  80                 is missing, the implementation selects an appropriate importer.
  81                 By default, a <type>MergeImporter</type> should be used.
  82             </dd>
  83             <dt><code>OverwriteExisting</code> : <atom >boolean</atom></dt>
  84             <dd>If <TRUE/>, specifies that no existing data should be
  85                 overwritten by the import. If the <type>Importer</type> used
  86                 does not support such protection, an error may be raised.
  87                 If some data is not imported, because there is existing
  88                 data, this is indicated by returning an appropriate exception.
  89             </dd>
  90             <dt><code>TruncateExisting</code> : <atom >boolean</atom></dt>
  91             <dd>If <TRUE/>, specifies that existing data should be
  92                 discarded and replaced by the imported data.
  93                 If the <type>Importer</type> used does not support this
  94                 operation, an error may be raised.
  95                 By default, a <type>CopyImporter</type> is used to perform
  96                 truncating import.
  97             </dd>
  98             <dt><code>Entity</code> : <atom >string</atom></dt>
  99             <dd>An identifier for the entity in the destination backend for
 100                 which the imported data should apply. The value will be passed
 101                 to <member>XLayerImporter::importLayerForEntity()</member>.
 102                 If this parameter is missing, the implementation uses
 103                 <member>XLayerImporter::importLayer()</member> instead.
 104             </dd>
 105             <dt><code>Component</code> : <atom >string</atom></dt>
 106             <dd>Names the component for which to import data. If this
 107                 parameter is missing, the selection of data to import depends
 108                 on implementation-specific parameters.
 109             </dd>
 110             <dt><code>LayerFilter</code> : <type >LayerFilter</type></dt>
 111             <dd>A filter to transform data during import. This parameter is
 112                 optional. If this parameter is missing, data will be imported
 113                 unaltered. <em>Support for this parameter is optional.</em>
 114                 If the implementation does not support a filter it will raise an
 115                 <type scope="com::sun::star::lang">IllegalArgumentException</type>.
 116             </dd>
 117         </dl>
 118         </p>
 119
 120       */
 121     interface com::sun::star::task::XJob ;
 122
 123     //-------------------------------------------------------------------------
 124 } ;
 125
 126 //=============================================================================
 127
 128 } ; } ; } ; } ; } ;
 129
 130 #endif