1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_configuration_backend_LocalDataImporter_idl__
28#define __com_sun_star_configuration_backend_LocalDataImporter_idl__
29
30#ifndef __com_sun_star_configuration_backend_DataImporter_idl__
31#include <com/sun/star/configuration/backend/DataImporter.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module configuration { module backend {
37
38//=============================================================================
39
40/**
41    allows importing data from a local configuration data repository
42    or file into any <type>Backend</type>.
43
44    <p> Data to be imported can be a single layer either from a full local
45        configuration database or from a particular OOR Update XML file.
46    </p>
47    <p> Data is imported into the <type>DefaultBackend</type>.
48    </p>
49
50    @see com::sun::star::configuration::backend::LocalHierarchyBrowser
51        Service that can be used to locate available layer files or components.
52
53    @see com::sun::star::configuration::backend::LocalSingleBackend
54        Service that can be used to access a local configuration database.
55
56    @since OOo 1.1.2
57*/
58published service LocalDataImporter
59{
60	//-------------------------------------------------------------------------
61
62    /** provides for running an import job
63
64        <p> The implementation returns <void/> from
65            <member scope="com::sun::star::task">XJob::execute()</member>
66            to indicates successful execution. If import is not executed,
67            because <code>OverwriteExisting = </code><TRUE/> was specified,
68            a <type scope="com::sun::star::lang">IllegalAccessException</type>
69            is returned.
70        </p>
71         <p>If <void/> or <TRUE/> is returned, this indicates successful
72            execution. If an
73            <type scope="com::sun::star::uno">Exception</type> is returned,
74            it represents an error condition encountered during execution.
75        </p>
76
77        <p> The standard arguments to
78            <member scope="com::sun::star::task">XJob::execute()</member>
79            are all supported by implementations. Additionally the following
80            argument is required to select the data source:
81        <dl>
82            <dt><code>LayerDataUrl</code> : <atom >string</atom></dt>
83            <dd>A file URL that specifies the location of the source data.
84                <p> If no <code>Component</code> is provided, this must be the
85                    location of an OOR Update XML file, which will be imported
86                    directly.
87                </p>
88                <p> If a <code>Component</code> is provided, the
89                    <code>LayerDataUrl</code> is treated as Entity
90                    (i.e. Layer directory base URL) for a local
91                    configuration database and the appropriate component
92                    from that repository is imported.
93                </p>
94            </dd>
95        </dl>
96        </p>
97        <p> Implementations may support additional parameters to select
98            a destination <type>Backend</type>, that is not the
99            <type>DefaultBackend</type>.
100        </p>
101      */
102    service DataImporter ;
103
104	//-------------------------------------------------------------------------
105} ;
106
107//=============================================================================
108
109} ; } ; } ; } ; } ;
110
111#endif
112