<html> <head> <title>Service DataImporter</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="DataImporter-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</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">Included Services</td> <td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td> <td class="navisub">Properties' Summary</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 DataImporter</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows importing data from one configuration repository into another. . </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> </td> </tr> </table> <hr> <a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../task/module-ix.html">task</a>::<a href="../../task/XJob.html">XJob</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>allows running an import job </dd> <dd><p> The source and destination repositories are selected by arguments passed 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>. The names and meanings of such arguments depend on the implementation. Each implementation must document such arguments. </p> <p> Implementations may return a value 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> that indicates the status of job execution. The type and meaning of such status indicators depend on the implementation. </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 following 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> should be supported by implementations. Implementations must document a failure to support any of these arguments: <dl> <dt><code>ImporterService</code> : <code>string</code></dt> <dd>A service or implementation name used to instantiate the <a href="Importer.html">Importer</a> to use for importing. If this parameter is missing, the implementation selects an appropriate importer. By default, a <a href="MergeImporter.html">MergeImporter</a> should be used. </dd> <dt><code>OverwriteExisting</code> : <code>boolean</code></dt> <dd>If <b>true</b>, specifies that no existing data should be overwritten by the import. If the <a href="Importer.html">Importer</a> used does not support such protection, an error may be raised. If some data is not imported, because there is existing data, this is indicated by returning an appropriate exception. </dd> <dt><code>TruncateExisting</code> : <code>boolean</code></dt> <dd>If <b>true</b>, specifies that existing data should be discarded and replaced by the imported data. If the <a href="Importer.html">Importer</a> used does not support this operation, an error may be raised. By default, a <a href="CopyImporter.html">CopyImporter</a> is used to perform truncating import. </dd> <dt><code>Entity</code> : <code>string</code></dt> <dd>An identifier for the entity in the destination backend for which the imported data should apply. The value will be passed to <a href="XLayerImporter.html">XLayerImporter</a>::<a href="XLayerImporter.html#importLayerForEntity">importLayerForEntity()</a>. If this parameter is missing, the implementation uses <a href="XLayerImporter.html">XLayerImporter</a>::<a href="XLayerImporter.html#importLayer">importLayer()</a> instead. </dd> <dt><code>Component</code> : <code>string</code></dt> <dd>Names the component for which to import data. If this parameter is missing, the selection of data to import depends on implementation-specific parameters. </dd> <dt><code>LayerFilter</code> : <a href="LayerFilter.html">LayerFilter</a></dt> <dd>A filter to transform data during import. This parameter is optional. If this parameter is missing, data will be imported unaltered. <em>Support for this parameter is optional.</em> If the implementation does not support a filter it will raise an ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a>. </dd> </dl> </p> </dd> </dl> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
1973
