xref: /aoo4110/main/offapi/com/sun/star/configuration/backend/LocalDataImporter.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_configuration_backend_LocalDataImporter_idl__
#define __com_sun_star_configuration_backend_LocalDataImporter_idl__

#ifndef __com_sun_star_configuration_backend_DataImporter_idl__
#include <com/sun/star/configuration/backend/DataImporter.idl>
#endif

//=============================================================================

module com { module sun { module star { module configuration { module backend {

//=============================================================================

/**
    allows importing data from a local configuration data repository
    or file into any <type>Backend</type>.

    <p> Data to be imported can be a single layer either from a full local
        configuration database or from a particular OOR Update XML file.
    </p>
    <p> Data is imported into the <type>DefaultBackend</type>.
    </p>

    @see com::sun::star::configuration::backend::LocalHierarchyBrowser
        Service that can be used to locate available layer files or components.

    @see com::sun::star::configuration::backend::LocalSingleBackend
        Service that can be used to access a local configuration database.

    @since OpenOffice 1.1.2
*/
published service LocalDataImporter
{
	//-------------------------------------------------------------------------

    /** provides for running an import job

        <p> The implementation returns <void/> from
            <member scope="com::sun::star::task">XJob::execute()</member>
            to indicates successful execution. If import is not executed,
            because <code>OverwriteExisting = </code><TRUE/> was specified,
            a <type scope="com::sun::star::lang">IllegalAccessException</type>
            is returned.
        </p>
         <p>If <void/> or <TRUE/> is returned, this indicates successful
            execution. If an
            <type scope="com::sun::star::uno">Exception</type> is returned,
            it represents an error condition encountered during execution.
        </p>

        <p> The standard arguments to
            <member scope="com::sun::star::task">XJob::execute()</member>
            are all supported by implementations. Additionally the following
            argument is required to select the data source:
        <dl>
            <dt><code>LayerDataUrl</code> : <atom >string</atom></dt>
            <dd>A file URL that specifies the location of the source data.
                <p> If no <code>Component</code> is provided, this must be the
                    location of an OOR Update XML file, which will be imported
                    directly.
                </p>
                <p> If a <code>Component</code> is provided, the
                    <code>LayerDataUrl</code> is treated as Entity
                    (i.e. Layer directory base URL) for a local
                    configuration database and the appropriate component
                    from that repository is imported.
                </p>
            </dd>
        </dl>
        </p>
        <p> Implementations may support additional parameters to select
            a destination <type>Backend</type>, that is not the
            <type>DefaultBackend</type>.
        </p>
      */
    service DataImporter ;

	//-------------------------------------------------------------------------
} ;

//=============================================================================

} ; } ; } ; } ; } ;

#endif