<html> <head> <title>Interface XBackendEntities</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="XBackendEntities-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 XBackendEntities</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Provides functionality relating to common and supported entities for a configuration data backend. </dd> <dt><b>Since </b></dt> <dd>OpenOffice 1.1.2</dd> <dt><b>See also</b></dt> <dd><a href="XBackend.html">XBackend</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="#getOwnerEntity">getOwnerEntity</a></td> <td class="imsum_right">provides the entity id of the owner entity of the backend. </td> </tr> <tr> <td class="imsum_left"><a href="#getAdminEntity">getAdminEntity</a></td> <td class="imsum_right">provides the entity id of an entity for general administrative access. </td> </tr> <tr> <td class="imsum_left"><a href="#supportsEntity">supportsEntity</a></td> <td class="imsum_right">determines, if a given entity id exists in this backend. </td> </tr> <tr> <td class="imsum_left"><a href="#isEqualEntity">isEqualEntity</a></td> <td class="imsum_right">determines, if two given entity ids denote the same 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="getOwnerEntity" class="membertitle">getOwnerEntity</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>getOwnerEntity</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides the entity id of the owner entity of the backend. </dd> <dt><b>Returns</b></dt> <dd>an entity identifier for the owner entity. <p> The owner entity is the default entity for the backend. For normal configuration data access the owner entity should always be used. </p> </dd> <dt><b>See also</b></dt> <dd><a href="XBackend.html">XBackend</a>::<a href="XBackend.html#listOwnLayers">listOwnLayers()</a>, <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="getAdminEntity" class="membertitle">getAdminEntity</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>getAdminEntity</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides the entity id of an entity for general administrative access. </dd> <dd><p> The admin entity is an entity that should be used to read and manage configuration data that applies to all entities within the backend. </p> </dd> <dt><b>Returns</b></dt> <dd>an entity identifier for the admin entity or an empty string, if there is no entity that can be used for general administrative access. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="supportsEntity" class="membertitle">supportsEntity</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">boolean</td> </tr> <tr> <td valign="top"><b>supportsEntity</b>(</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> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines, if a given entity id exists in this backend. </dd> <dt><b>Parameter aEntity</b></dt> <dd>The name of an entity. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the backend. </dd> <dt><b>Returns</b></dt> <dd><b>true</b>, if aEntity is a valid, existing entity for this backend, <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isEqualEntity" class="membertitle">isEqualEntity</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">boolean</td> </tr> <tr> <td valign="top"><b>isEqualEntity</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aEntity,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aOtherEntity )</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>determines, if two given entity ids denote the same entity. </dd> <dt><b>Parameter aEntity</b></dt> <dd>The name of an entity. </dd> <dt><b>Parameter aOtherEntity</b></dt> <dd>The name of another entity. </dd> <dt><b>Returns</b></dt> <dd><b>true</b>, if aEntity and aOtherEntity denote the same entity within this backend, <b>false</b> otherwise. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the backend. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::IllegalArgumentException if either entity does not exist. </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
>
2057
