<html> <head> <title>Interface XBackend</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="XBackend-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 XBackend</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Handles access to layered data stored in a repository. </dd> <dd><p> Data can be retrieved on behalf of one or more entities.</p> <p> There is an implied owner entity associated to the object when it is created. This entity should be used for normal data access. For administrative operations data of other entities can be accessed. </p> </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> <dt><b>See also</b></dt> <dd><a href="XBackendEntities.html">XBackendEntities</a>, <a href="XSchemaSupplier.html">XSchemaSupplier</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="#listOwnLayers">listOwnLayers</a></td> <td class="imsum_right">retrieves the layers associated to the owner entity for a component. </td> </tr> <tr> <td class="imsum_left"><a href="#getOwnUpdateHandler">getOwnUpdateHandler</a></td> <td class="imsum_right">creates an update handler for the owner entity layer for a component. </td> </tr> <tr> <td class="imsum_left"><a href="#listLayers">listLayers</a></td> <td class="imsum_right">retrieves the layers associated to an entity for a component. </td> </tr> <tr> <td class="imsum_left"><a href="#getUpdateHandler">getUpdateHandler</a></td> <td class="imsum_right">creates an update handler on an entity's 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="listOwnLayers" class="membertitle">listOwnLayers</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>listOwnLayers</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/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the layers associated to the owner entity for a component. </dd> <dt><b>Parameter aComponent</b></dt> <dd>component whose data will be accessed </dd> <dt><b>Returns</b></dt> <dd>a list of objects allowing access to the component data for each layer associated to the current entity </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::configuration::backend::BackendAccessException if an error occurs while accessing the data. </dd> <dt><b>See also</b></dt> <dd><a href="XBackendEntities.html">XBackendEntities</a>::<a href="XBackendEntities.html#getOwnerEntity">getOwnerEntity()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getOwnUpdateHandler" class="membertitle">getOwnUpdateHandler</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="XUpdateHandler.html">XUpdateHandler</a></td> </tr> <tr> <td valign="top"><b>getOwnUpdateHandler</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>creates an update handler for the owner entity layer for a component. </dd> <dt><b>Parameter aComponent</b></dt> <dd>component whose data will be updated </dd> <dt><b>Returns</b></dt> <dd>an object allowing manipulation of the component data for the current entity </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 updates are not supported for this backend </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="XBackendEntities.html">XBackendEntities</a>::<a href="XBackendEntities.html#getOwnerEntity">getOwnerEntity()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="listLayers" class="membertitle">listLayers</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>listLayers</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>retrieves the layers associated to an entity for a component. </dd> <dt><b>Parameter aComponent</b></dt> <dd>component whose data will be accessed </dd> <dt><b>Parameter aEntity</b></dt> <dd>entity whose data will be accessed </dd> <dt><b>Returns</b></dt> <dd>a list of objects allowing access to the component data for each layer associated with the entity. </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="XBackendEntities.html">XBackendEntities</a>::<a href="XBackendEntities.html#supportsEntity">supportsEntity()</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getUpdateHandler" class="membertitle">getUpdateHandler</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="XUpdateHandler.html">XUpdateHandler</a></td> </tr> <tr> <td valign="top"><b>getUpdateHandler</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>creates an update handler on an entity's layer for a component. </dd> <dt><b>Parameter aComponent</b></dt> <dd>component whose data will be updated </dd> <dt><b>Parameter aEntity</b></dt> <dd>entity whose data will be updated </dd> <dt><b>Returns</b></dt> <dd>an object allowing manipulation of the component data for the entity </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 updates are not supported for this backend </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="XBackendEntities.html">XBackendEntities</a>::<a href="XBackendEntities.html#supportsEntity">supportsEntity()</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 © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
2051
