1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_configuration_backend_DataImporter_idl__
24#define __com_sun_star_configuration_backend_DataImporter_idl__
25
26#ifndef __com_sun_star_task_XJob_idl__
27#include <com/sun/star/task/XJob.idl>
28#endif
29
30//=============================================================================
31
32module com { module sun { module star { module configuration { module backend {
33
34//=============================================================================
35
36/**
37    allows importing data from one configuration repository into another. .
38
39    @since OpenOffice 1.1.2
40*/
41published service DataImporter
42{
43	//-------------------------------------------------------------------------
44
45    /** allows running an import job
46
47        <p> The source and destination repositories are selected by arguments
48            passed to
49            <member scope="com::sun::star::task">XJob::execute()</member>.
50            The names and meanings of such arguments depend on
51            the implementation. Each implementation must document such arguments.
52        </p>
53
54        <p> Implementations may return a value from
55            <member scope="com::sun::star::task">XJob::execute()</member>
56            that indicates the status of job execution. The type and meaning of
57            such status indicators depend on the implementation.
58        </p>
59         <p>If <void/> or <TRUE/> is returned, this indicates successful
60            execution. If an
61            <type scope="com::sun::star::uno">Exception</type> is returned,
62            it represents an error condition encountered during execution.
63        </p>
64
65        <p> The following arguments to
66            <member scope="com::sun::star::task">XJob::execute()</member>
67            should be supported by implementations. Implementations must document
68            a failure to support any of these arguments:
69        <dl>
70            <dt><code>ImporterService</code> : <atom >string</atom></dt>
71            <dd>A service or implementation name used to instantiate the
72                <type>Importer</type> to use for importing. If this parameter
73                is missing, the implementation selects an appropriate importer.
74                By default, a <type>MergeImporter</type> should be used.
75            </dd>
76            <dt><code>OverwriteExisting</code> : <atom >boolean</atom></dt>
77            <dd>If <TRUE/>, specifies that no existing data should be
78                overwritten by the import. If the <type>Importer</type> used
79                does not support such protection, an error may be raised.
80                If some data is not imported, because there is existing
81                data, this is indicated by returning an appropriate exception.
82            </dd>
83            <dt><code>TruncateExisting</code> : <atom >boolean</atom></dt>
84            <dd>If <TRUE/>, specifies that existing data should be
85                discarded and replaced by the imported data.
86                If the <type>Importer</type> used does not support this
87                operation, an error may be raised.
88                By default, a <type>CopyImporter</type> is used to perform
89                truncating import.
90            </dd>
91            <dt><code>Entity</code> : <atom >string</atom></dt>
92            <dd>An identifier for the entity in the destination backend for
93                which the imported data should apply. The value will be passed
94                to <member>XLayerImporter::importLayerForEntity()</member>.
95                If this parameter is missing, the implementation uses
96                <member>XLayerImporter::importLayer()</member> instead.
97            </dd>
98            <dt><code>Component</code> : <atom >string</atom></dt>
99            <dd>Names the component for which to import data. If this
100                parameter is missing, the selection of data to import depends
101                on implementation-specific parameters.
102            </dd>
103            <dt><code>LayerFilter</code> : <type >LayerFilter</type></dt>
104            <dd>A filter to transform data during import. This parameter is
105                optional. If this parameter is missing, data will be imported
106                unaltered. <em>Support for this parameter is optional.</em>
107                If the implementation does not support a filter it will raise an
108                <type scope="com::sun::star::lang">IllegalArgumentException</type>.
109            </dd>
110        </dl>
111        </p>
112
113      */
114    interface com::sun::star::task::XJob ;
115
116	//-------------------------------------------------------------------------
117} ;
118
119//=============================================================================
120
121} ; } ; } ; } ; } ;
122
123#endif
124