<html> <head> <title>Interface XSingleLayerStratum</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="XSingleLayerStratum-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"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</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 XSingleLayerStratum</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Handles access to a stratum consisting of a single layer in a configuration data repository </dd> <dd><p> The interface provides timestamp-checking capabilities for efficient caching. </p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XTimeStamped.html">XTimeStamped</a>, <a href="XSchemaSupplier.html">XSchemaSupplier</a>, <a href="XMultiLayerStratum.html">XMultiLayerStratum</a></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="#getLayer">getLayer</a></td> <td class="imsum_right">retrieves the layer data for a component, if newer than indicated. </td> </tr> <tr> <td class="imsum_left"><a href="#getUpdatableLayer">getUpdatableLayer</a></td> <td class="imsum_right">retrieves a writable representation of the layer for a component. </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="getLayer" class="membertitle">getLayer</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="XLayer.html">XLayer</a></td> </tr> <tr> <td valign="top"><b>getLayer</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aComponent,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aTimestamp )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="BackendAccessException.html">BackendAccessException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the layer data for a component, if newer than indicated. </dd> <dd><p> A timestamp can be provided, which is used to indicate a point in time. The layer should be returned only if is modified since that time. </p> </dd> <dt><b>Parameter aComponent</b></dt> <dd>The name of the component to access. </dd> <dt><b>Parameter aTimestamp</b></dt> <dd>a timestamp for the layer. <p> An empty timestamp indicates, that the layer should be retrieved irrespective of its modification time. </p> <p> The format and meaning of a timestamp depends on the implementation. Timestamps can be obtained using ::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XTimeStamped.html">XTimeStamped</a>::<a href="../../util/XTimeStamped.html#getTimestamp">getTimestamp()</a>. </p> </dd> <dt><b>Returns</b></dt> <dd>a <a href="Layer.html">Layer</a> object providing access to the layer data, <b>NULL</b> if the layer is newer than indicated by the timestamp. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the component identifier is invalid or if the timestamp is invalid. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the data. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../../util/module-ix.html">util</a>::<a href="../../util/XTimeStamped.html">XTimeStamped</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getUpdatableLayer" class="membertitle">getUpdatableLayer</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="XUpdatableLayer.html">XUpdatableLayer</a></td> </tr> <tr> <td valign="top"><b>getUpdatableLayer</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aComponent )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="BackendAccessException.html">BackendAccessException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/NoSupportException.html">NoSupportException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves a writable representation of the layer for a component. </dd> <dt><b>Parameter aComponent</b></dt> <dd>The name of the component to access. </dd> <dt><b>Returns</b></dt> <dd>an <a href="UpdatableLayer.html">UpdatableLayer</a> object providing write access to the layer </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the component identifier is invalid. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::NoSupportException if the implementation does not support updates. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the data. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <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>