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