<html> <head> <title>Service LocalDataImporter</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="LocalDataImporter-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Config/Installing_a_Custom_Configuration_Schema" class="navimain">Devguide</a></td> <td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#ServicesSummary" class="navisub">Services' Summary</a></td> <td class="navisub">Interfaces' Summary</td> <td class="navisub">Properties' Summary</td> <td class="navisub"><a href="#ServicesDetails" class="navisub">Services' Details</a></td> <td class="navisub">Interfaces' Details</td> <td class="navisub">Properties' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">configuration</a> :: <a href="module-ix.html" class="namechain">backend</a> :: </p> </td> </tr> <tr> <td class="title">service LocalDataImporter</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows importing data from a local configuration data repository or file into any <a href="Backend.html">Backend</a>. </dd> <dd><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 <a href="DefaultBackend.html">DefaultBackend</a>. </p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> <dt><b>See also</b></dt> <dd><a href="LocalHierarchyBrowser.html">LocalHierarchyBrowser</a><br> Service that can be used to locate available layer files or components. </dd> <dt><b>See also</b></dt> <dd><a href="LocalSingleBackend.html">LocalSingleBackend</a><br> Service that can be used to access a local configuration database. </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Config/Installing_a_Custom_Configuration_Schema">Config - Installing a Custom Configuration Schema</a></dd> </dl> </td> </tr> </table> <hr> <a name="ServicesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Summary</td> </tr> <tr> <td class="imsum_left"><a href="DataImporter.html">DataImporter</a></td> <td class="imsum_right"><p>provides for running an import job (<a href="#DataImporter">details</a>)</p> </td> </tr> </table> <a name="ServicesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services - Details</td> </tr> <tr/> <tr> <td class="imdetail"><a name="DataImporter" class="membertitle"><a href="DataImporter.html">DataImporter</a></a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides for running an import job </dd> <dd><p> The implementation returns <b>void</b> from ::com::sun::star::<a href="../../task/module-ix.html">task</a>::<a href="../../task/XJob.html">XJob</a>::<a href="../../task/XJob.html#execute">execute()</a> to indicates successful execution. If import is not executed, because <code>OverwriteExisting = </code><b>true</b> was specified, a ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalAccessException.html">IllegalAccessException</a> is returned. </p> <p>If <b>void</b> or <b>true</b> is returned, this indicates successful execution. If an ::com::sun::star::<a href="../../uno/module-ix.html">uno</a>::<a href="../../uno/Exception.html">Exception</a> is returned, it represents an error condition encountered during execution. </p> <p> The standard arguments to ::com::sun::star::<a href="../../task/module-ix.html">task</a>::<a href="../../task/XJob.html">XJob</a>::<a href="../../task/XJob.html#execute">execute()</a> are all supported by implementations. Additionally the following argument is required to select the data source: <dl> <dt><code>LayerDataUrl</code> : <code>string</code></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 <a href="Backend.html">Backend</a>, that is not the <a href="DefaultBackend.html">DefaultBackend</a>. </p> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>