<html> <head> <title>Interface XSimpleRegistry</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="XSimpleRegistry-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">registry</a> :: </p> </td> </tr> <tr> <td class="title">interface XSimpleRegistry</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>allows access to a registry (a persistent data source). The data is stored in a hierarchical key structure beginning with a root key. Each key can store a value and can have multiple subkeys. </dd> <dt><b>See also</b></dt> <dd><a href="XRegistryKey.html">XRegistryKey</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="#getURL">getURL</a></td> <td class="imsum_right">returns the URL of the current data source of the registry. </td> </tr> <tr> <td class="imsum_left"><a href="#open">open</a></td> <td class="imsum_right">connects the registry to a persistent data source represented by an URL. </td> </tr> <tr> <td class="imsum_left"><a href="#isValid">isValid</a></td> <td class="imsum_right">checks if the registry points to a valid data-source. </td> </tr> <tr> <td class="imsum_left"><a href="#close">close</a></td> <td class="imsum_right">disconnects the registry from the data-source. </td> </tr> <tr> <td class="imsum_left"><a href="#destroy">destroy</a></td> <td class="imsum_right">destroys the registry and the data source. </td> </tr> <tr> <td class="imsum_left"><a href="#getRootKey">getRootKey</a></td> <td class="imsum_right"> </td> </tr> <tr> <td class="imsum_left"><a href="#isReadOnly">isReadOnly</a></td> <td class="imsum_right">checks if the registry is readonly. </td> </tr> <tr> <td class="imsum_left"><a href="#mergeKey">mergeKey</a></td> <td class="imsum_right">DEPRECATED: this method lacks a registry key (better than a URL). merges a registry under the specified key. </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="getURL" class="membertitle">getURL</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>getURL</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns the URL of the current data source of the registry. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="open" class="membertitle">open</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>open</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> rURL,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bReadOnly,</td> </tr> <tr> <td/><td valign="top">[in] boolean</td> <td valign="bottom"> bCreate )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>connects the registry to a persistent data source represented by an URL. </dd> <dd><p>If a local registry is already open, this function will close the currently open registry. </dd> <dt><b>Parameter aURL</b></dt> <dd>specifies the complete URL to access the data source. </dd> <dt><b>Parameter bReadOnly</b></dt> <dd>specifies if the data source should be opened for read only. </dd> <dt><b>Parameter bCreate</b></dt> <dd>specifies if the data source should be created if it does not already exist. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry does not exist. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isValid" class="membertitle">isValid</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>isValid</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>checks if the registry points to a valid data-source. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="close" class="membertitle">close</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>close</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>disconnects the registry from the data-source. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="destroy" class="membertitle">destroy</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>destroy</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>destroys the registry and the data source. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRootKey" class="membertitle">getRootKey</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="XRegistryKey.html">XRegistryKey</a></td> </tr> <tr> <td valign="top"><b>getRootKey</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Returns</b></dt> <dd>the root key of the registry. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if no registry is open </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isReadOnly" class="membertitle">isReadOnly</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>isReadOnly</b>()</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>checks if the registry is readonly. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="mergeKey" class="membertitle">mergeKey</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>mergeKey</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> aKeyName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> aUrl )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="InvalidRegistryException.html">InvalidRegistryException</a>,<br> <a href="MergeConflictException.html">MergeConflictException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>DEPRECATED: this method lacks a registry key (better than a URL). merges a registry under the specified key. </dd> <dd><p>If the key does not exist it will be created. Existing keys will be overridden from keys of registry specified by <var>aUrl</var>. </dd> <dt><b>Throws</b></dt> <dd>InvalidRegistryException if the registry is not open. </dd> <dt><b>Throws</b></dt> <dd>MergeConflictException if any differences occur during merging </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>