1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_LocalDataImporter_idl__ 24cdf0e10cSrcweir#define __com_sun_star_configuration_backend_LocalDataImporter_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_DataImporter_idl__ 27cdf0e10cSrcweir#include <com/sun/star/configuration/backend/DataImporter.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir//============================================================================= 31cdf0e10cSrcweir 32cdf0e10cSrcweirmodule com { module sun { module star { module configuration { module backend { 33cdf0e10cSrcweir 34cdf0e10cSrcweir//============================================================================= 35cdf0e10cSrcweir 36cdf0e10cSrcweir/** 37cdf0e10cSrcweir allows importing data from a local configuration data repository 38cdf0e10cSrcweir or file into any <type>Backend</type>. 39cdf0e10cSrcweir 40cdf0e10cSrcweir <p> Data to be imported can be a single layer either from a full local 41cdf0e10cSrcweir configuration database or from a particular OOR Update XML file. 42cdf0e10cSrcweir </p> 43cdf0e10cSrcweir <p> Data is imported into the <type>DefaultBackend</type>. 44cdf0e10cSrcweir </p> 45cdf0e10cSrcweir 46cdf0e10cSrcweir @see com::sun::star::configuration::backend::LocalHierarchyBrowser 47cdf0e10cSrcweir Service that can be used to locate available layer files or components. 48cdf0e10cSrcweir 49cdf0e10cSrcweir @see com::sun::star::configuration::backend::LocalSingleBackend 50cdf0e10cSrcweir Service that can be used to access a local configuration database. 51cdf0e10cSrcweir 52*0d3a54ffSJürgen Schmidt @since OpenOffice 1.1.2 53cdf0e10cSrcweir*/ 54cdf0e10cSrcweirpublished service LocalDataImporter 55cdf0e10cSrcweir{ 56cdf0e10cSrcweir //------------------------------------------------------------------------- 57cdf0e10cSrcweir 58cdf0e10cSrcweir /** provides for running an import job 59cdf0e10cSrcweir 60cdf0e10cSrcweir <p> The implementation returns <void/> from 61cdf0e10cSrcweir <member scope="com::sun::star::task">XJob::execute()</member> 62cdf0e10cSrcweir to indicates successful execution. If import is not executed, 63cdf0e10cSrcweir because <code>OverwriteExisting = </code><TRUE/> was specified, 64cdf0e10cSrcweir a <type scope="com::sun::star::lang">IllegalAccessException</type> 65cdf0e10cSrcweir is returned. 66cdf0e10cSrcweir </p> 67cdf0e10cSrcweir <p>If <void/> or <TRUE/> is returned, this indicates successful 68cdf0e10cSrcweir execution. If an 69cdf0e10cSrcweir <type scope="com::sun::star::uno">Exception</type> is returned, 70cdf0e10cSrcweir it represents an error condition encountered during execution. 71cdf0e10cSrcweir </p> 72cdf0e10cSrcweir 73cdf0e10cSrcweir <p> The standard arguments to 74cdf0e10cSrcweir <member scope="com::sun::star::task">XJob::execute()</member> 75cdf0e10cSrcweir are all supported by implementations. Additionally the following 76cdf0e10cSrcweir argument is required to select the data source: 77cdf0e10cSrcweir <dl> 78cdf0e10cSrcweir <dt><code>LayerDataUrl</code> : <atom >string</atom></dt> 79cdf0e10cSrcweir <dd>A file URL that specifies the location of the source data. 80cdf0e10cSrcweir <p> If no <code>Component</code> is provided, this must be the 81cdf0e10cSrcweir location of an OOR Update XML file, which will be imported 82cdf0e10cSrcweir directly. 83cdf0e10cSrcweir </p> 84cdf0e10cSrcweir <p> If a <code>Component</code> is provided, the 85cdf0e10cSrcweir <code>LayerDataUrl</code> is treated as Entity 86cdf0e10cSrcweir (i.e. Layer directory base URL) for a local 87cdf0e10cSrcweir configuration database and the appropriate component 88cdf0e10cSrcweir from that repository is imported. 89cdf0e10cSrcweir </p> 90cdf0e10cSrcweir </dd> 91cdf0e10cSrcweir </dl> 92cdf0e10cSrcweir </p> 93cdf0e10cSrcweir <p> Implementations may support additional parameters to select 94cdf0e10cSrcweir a destination <type>Backend</type>, that is not the 95cdf0e10cSrcweir <type>DefaultBackend</type>. 96cdf0e10cSrcweir </p> 97cdf0e10cSrcweir */ 98cdf0e10cSrcweir service DataImporter ; 99cdf0e10cSrcweir 100cdf0e10cSrcweir //------------------------------------------------------------------------- 101cdf0e10cSrcweir} ; 102cdf0e10cSrcweir 103cdf0e10cSrcweir//============================================================================= 104cdf0e10cSrcweir 105cdf0e10cSrcweir} ; } ; } ; } ; } ; 106cdf0e10cSrcweir 107cdf0e10cSrcweir#endif 108