<html> <head> <title>Interface XMultiLayerStratum</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="XMultiLayerStratum-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 XMultiLayerStratum</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Handles access to a stratum consisting of multiple layers in a single configuration data repository </dd> <dd><p> The interface provides access to data for multiple entities and timestamp-checking capabilities for efficient caching. </p> </dd> <dt><b>Since </b></dt> <dd>OOo 1.1.2</dd> <dt><b>See also</b></dt> <dd><a href="XBackendEntities.html">XBackendEntities</a>, ::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="XSingleLayerStratum.html">XSingleLayerStratum</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="#listLayerIds">listLayerIds</a></td> <td class="imsum_right">identifies the layers within this stratum which should be read and merged to determine data of a component for an entity </td> </tr> <tr> <td class="imsum_left"><a href="#getUpdateLayerId">getUpdateLayerId</a></td> <td class="imsum_right">identifies the layer which should be modified to update data of a component on behalf of an entity. </td> </tr> <tr> <td class="imsum_left"><a href="#getLayer">getLayer</a></td> <td class="imsum_right">retrieves a layer associated to a layer id, if newer than indicated. </td> </tr> <tr> <td class="imsum_left"><a href="#getLayers">getLayers</a></td> <td class="imsum_right">retrieves the layers associated to a series of layer ids, if newer than indicated. </td> </tr> <tr> <td class="imsum_left"><a href="#getMultipleLayers">getMultipleLayers</a></td> <td class="imsum_right">retrieves the layers associated to a series of layer ids, if newer than indicated for each layer. </td> </tr> <tr> <td class="imsum_left"><a href="#getUpdatableLayer">getUpdatableLayer</a></td> <td class="imsum_right">retrieves a writable representation of the layer associated to a layer id. </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="listLayerIds" class="membertitle">listLayerIds</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">sequence< string ></td> </tr> <tr> <td valign="top"><b>listLayerIds</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"> aEntity )</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>identifies the layers within this stratum which should be read and merged to determine data of a component for an entity </dd> <dt><b>Parameter aComponent</b></dt> <dd>The name of the component to access. </dd> <dt><b>Parameter aEntity</b></dt> <dd>The name of an entity on behalf of which data will be accessed. </dd> <dt><b>Returns</b></dt> <dd>a list of layer identifiers that can be used to retrieve <a href="Layer.html">Layer</a> objects. <p> The list is ordered by priority. Typically the most general layers (global defaults, entire organization) are first, more specific layers (associated to specific groups or roles) are next and the entity's own data is last. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the component identifier is invalid or if the entity doesn't exist. </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><a href="XMultiLayerStratum.html">XMultiLayerStratum</a>::<a href="XMultiLayerStratum.html#getLayer">getLayer()</a>, <a href="XMultiLayerStratum.html">XMultiLayerStratum</a>::<a href="XMultiLayerStratum.html#getLayers">getLayers()</a>, <a href="XMultiLayerStratum.html">XMultiLayerStratum</a>::<a href="XMultiLayerStratum.html#getMultipleLayers">getMultipleLayers()</a>, <a href="XBackendEntities.html">XBackendEntities</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getUpdateLayerId" class="membertitle">getUpdateLayerId</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">string</td> </tr> <tr> <td valign="top"><b>getUpdateLayerId</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"> aEntity )</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>identifies the layer which should be modified to update data of a component on behalf of an entity. </dd> <dd><p> The layer id returned is one of the layer ids obtained from <a href="XMultiLayerStratum.html">XMultiLayerStratum</a>::<a href="XMultiLayerStratum.html#listLayerIds">listLayerIds()</a> for the same component and entity. </p> </dd> <dt><b>Parameter aComponent</b></dt> <dd>The name of the component to access. </dd> <dt><b>Parameter aEntity</b></dt> <dd>The name of an entity on behalf of which data will be accessed. </dd> <dt><b>Returns</b></dt> <dd>a layer identifier that can be used to obtain an <a href="UpdatableLayer.html">UpdatableLayer</a> object. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if the component identifier is invalid or if the entity doesn't exist. </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> <dt><b>See also</b></dt> <dd><a href="XMultiLayerStratum.html">XMultiLayerStratum</a>::<a href="XMultiLayerStratum.html#getUpdatableLayer">getUpdatableLayer()</a>, <a href="XBackendEntities.html">XBackendEntities</a></dd> </dl> </td> </tr> </table> </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"> aLayerId,</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 a layer associated to a layer id, 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 aLayerId</b></dt> <dd>identifier of the layers to be accessed. <p>Layer ids can be obtained from <a href="XMultiLayerStratum.html">XMultiLayerStratum</a>::<a href="XMultiLayerStratum.html#listLayerIds">listLayerIds()</a> or <a href="XMultiLayerStratum.html">XMultiLayerStratum</a>::<a href="XMultiLayerStratum.html#getUpdateLayerId">getUpdateLayerId()</a>. </p> </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 layer id 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="getLayers" class="membertitle">getLayers</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">sequence< <a href="XLayer.html">XLayer</a> ></td> </tr> <tr> <td valign="top"><b>getLayers</b>(</td> <td valign="top">[in] sequence< string ></td> <td valign="bottom"> aLayerIds,</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 layers associated to a series of layer ids, if newer than indicated. </dd> <dd><p> A timestamp can be provided, which is used to indicate a point in time. Only layers that are modified since that time should be returned. The same timestamp is used for all layers. </p> </dd> <dt><b>Parameter aLayerIds</b></dt> <dd>identifiers of the layers to be accessed. <p>Layer ids can be obtained from <a href="XMultiLayerStratum.html">XMultiLayerStratum</a>::<a href="XMultiLayerStratum.html#listLayerIds">listLayerIds()</a>. </p> </dd> <dt><b>Parameter aTimestamp</b></dt> <dd>a timestamp for all of the layers. <p> An empty timestamp indicates, that the layers should be retrieved irrespective of their 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 list of <a href="Layer.html">Layer</a> objects providing access to the layer data. <p> The list has the same length as aLayerIds. Each layer object is associated to the layer id in the corresponding position. </p> <p> For layers that are newer than indicated by the timestamp, the list contains a <b>NULL</b> element. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if one of the layer ids 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="getMultipleLayers" class="membertitle">getMultipleLayers</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">sequence< <a href="XLayer.html">XLayer</a> ></td> </tr> <tr> <td valign="top"><b>getMultipleLayers</b>(</td> <td valign="top">[in] sequence< string ></td> <td valign="bottom"> aLayerIds,</td> </tr> <tr> <td/><td valign="top">[in] sequence< string ></td> <td valign="bottom"> aTimestamps )</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 layers associated to a series of layer ids, if newer than indicated for each layer. </dd> <dd><p> For each layer an individual timestamp can be provided, which is used to indicate the last known version of the layer. Only layers that are modified since that time should be returned. </p> </dd> <dt><b>Parameter aLayerIds</b></dt> <dd>identifiers of the layers to be accessed. <p>Layer ids can be obtained from <a href="XMultiLayerStratum.html">XMultiLayerStratum</a>::<a href="XMultiLayerStratum.html#listLayerIds">listLayerIds()</a>. </p> </dd> <dt><b>Parameter aTimestamps</b></dt> <dd>timestamps for each of the layers. <p> This list must have the same length as aLayerIds. Timestamps are matched to layer ids by their position. </p> <p> An empty timestamp indicates, that the associated 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 list of <a href="Layer.html">Layer</a> objects providing access to the layer data. <p> The list has the same length as aLayerIds. Each layer object is associated to the layer id in the corresponding position. </p> <p> For layers that are newer than indicated by the corresponding timestamp, the list contains a <b>NULL</b> element. </p> </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if one of the layer ids is invalid or if one of the timestamps is invalid or if the lengths of the arguments don't match. </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"> aLayerId )</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 associated to a layer id. </dd> <dt><b>Parameter aLayerId</b></dt> <dd>identifier of the layer to be accessed for writing. <p>A layer id for writing can be obtained from <a href="XMultiLayerStratum.html">XMultiLayerStratum</a>::<a href="XMultiLayerStratum.html#getUpdateLayerId">getUpdateLayerId()</a>. </p> </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 layer id 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 © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
