<html> <head> <title>Interface XLayerImporter</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="XLayerImporter-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"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' 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">interface XLayerImporter</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows importing a layer into a <a href="Backend.html">Backend</a> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getTargetBackend">getTargetBackend</a></td> <td class="imsum_right">gets the target backend for importing. </td> </tr> <tr> <td class="imsum_left"><a href="#setTargetBackend">setTargetBackend</a></td> <td class="imsum_right">sets the target backend for importing. </td> </tr> <tr> <td class="imsum_left"><a href="#importLayer">importLayer</a></td> <td class="imsum_right">Imports the layer given into the backend. </td> </tr> <tr> <td class="imsum_left"><a href="#importLayerForEntity">importLayerForEntity</a></td> <td class="imsum_right">Imports the layer given into the backend for a given entity. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getTargetBackend" class="membertitle">getTargetBackend</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XBackend.html">XBackend</a></td> </tr> <tr> <td valign="top"><b>getTargetBackend</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the target backend for importing. </dd> <dt><b>Returns</b></dt> <dd>the <a href="Backend.html">Backend</a> into which layers are imported by </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setTargetBackend" class="membertitle">setTargetBackend</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setTargetBackend</b>(</td> <td valign="top">[in] <a href="XBackend.html">XBackend</a></td> <td valign="bottom"> aBackend )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/NullPointerException.html">NullPointerException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the target backend for importing. </dd> <dt><b>Parameter aBackend</b></dt> <dd>a <a href="Backend.html">Backend</a> into which layers should be imported by <method>XLayerImporter::importLayer()<method/>. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::NullPointerException if the backend passed is <b>NULL</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="importLayer" class="membertitle">importLayer</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>importLayer</b>(</td> <td valign="top">[in] <a href="XLayer.html">XLayer</a></td> <td valign="bottom"> aLayer )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/NullPointerException.html">NullPointerException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Imports the layer given into the backend. </dd> <dd><p>This method imports data for the current entity of the backend.</p> </dd> <dt><b>Parameter aLayer</b></dt> <dd>a layer whose data will be imported into the backend </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::NullPointerException if the layer passed is <b>NULL</b> or no backend is available. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException if the layer passed is invalid </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the layer passed is for a component that doesn't exist in the backend </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs in the backend or source layer. </dd> <dt><b>See also</b></dt> <dd><a href="XBackend.html">XBackend</a>::<a href="XBackend.html#getOwnUpdateHandler">getOwnUpdateHandler()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="importLayerForEntity" class="membertitle">importLayerForEntity</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>importLayerForEntity</b>(</td> <td valign="top">[in] <a href="XLayer.html">XLayer</a></td> <td valign="bottom"> aLayer,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aEntity )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="MalformedDataException.html">MalformedDataException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/NullPointerException.html">NullPointerException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Imports the layer given into the backend for a given entity. </dd> <dd><p>This method imports data for the current entity of the backend.</p> </dd> <dt><b>Parameter aLayer</b></dt> <dd>a layer whose data will be imported into the backend </dd> <dt><b>Parameter aEntity</b></dt> <dd>a entity into whose data the layer will be imported </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::NullPointerException if the layer passed is <b>NULL</b> or no backend is available. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException if the layer passed is invalid </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the layer passed is for a component that doesn't exist in the backend or if the entity doesn't exist in the backend. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs in the backend or source layer. </dd> <dt><b>See also</b></dt> <dd><a href="XBackend.html">XBackend</a>::<a href="XBackend.html#getUpdateHandler">getUpdateHandler()</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <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>