<html> <head> <title>Service ConfigurationAccess</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="ConfigurationAccess-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="#devmanual" class="navimain">Devguide</a></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="#IncludedServices" class="navisub">Included Services</a></td> <td class="navisub">Exported Interfaces</td> <td class="navisub">Properties' Summary</td> <td class="navisub">Properties' 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> :: </p> </td> </tr> <tr> <td class="title">service ConfigurationAccess</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>provides read access to a fragment of the configuration hierarchy. </dd> <dd><p>Values that are direct or indirect descendants of a root element can be retrieved and, if themselves objects, navigated. Other interfaces provide access to information about this element and its context. Changes to values in the hierarchy can be monitored by event listeners. </p> <p>Descendants of this service also implement this service. </p> <p>Ultimately the configuration holds values. These values are organized into a hierarchy using structural elements. The structure is defined in advance in a schema. Necessary information from the schema is stored in the configuration repository itself and is accessible through an implementation of this service. </p> <p>Two different kinds of structural elements are used in the configuration hierarchy: </p> <dl> <dt>Sets</dt> <dd>are dynamic containers of homogeneous elements. Which elements a <em>set</em> contains can vary. Their names are defined by the clients that insert them. On the other hand, the <em>type</em> of the elements is the same for all elements. In the case of elements that are themselves hierarchy objects, the <em>type</em> includes the structure of the hierarchy fragment they contain. Such types are defined in the configuration schema as <em>templates</em>. </dd> <dt>Groups</dt> <dd>are static collections of heterogeneous elements. The names and types of the elements of a <em>group</em> are completely defined in the configuration schema. Here each element may be of a different <em>type</em>, allowing <em>groups</em> that contain a mix of subobjects and simple values. </dd> </dl> <p>Objects in the configuration hierarchy, for example, implementations of this service, can thus be classified in the following ways: </p> <ul> <li><em>Container</em> role: An object that can hold child elements as a <em>set</em> or a <em>group</em>. </li> <li><em>Element</em> role: An object may be an element of a <em>set</em> or a <em>group</em> or else it may be the root element. </li> </ul> <p>Several types of simple <em>values</em> can be used in the configuration. In addition to the basic (scalar) types, sequences of the basic types are supported. The basic types are: </p> <ul> <li><strong>string</strong> can hold a human-readable text. <p>Values are represented as <code>string</code>.</p> <p>Sequences are represented as <code>string</code>[].</p> <p>'<em>human-readable</em>' here excludes non-printing characters except for CR, LF and TAB [Unicode code points 9,10,13]. For binary data, use type <strong>binary</strong> instead.</p> </li> <li><strong>boolean</strong> can hold the values <b>true</b> or <b>false</b>. <p>Values are represented as <code>boolean</code>. <p>Sequences are represented as <code>boolean</code>[].</p> </li> <li><strong>short</strong> can hold a 16-bit signed integer. <p>Values are represented as <code>short</code>.</p> <p>Sequences are represented as <code>short</code>[].</p> </li> <li><strong>int</strong> can hold a 32-bit signed integer. <p>Values are represented as <code>long</code>.</p> <p>Sequences are represented as <code>long</code>[].</p> </li> <li><strong>long</strong> can hold a 64-bit signed integer. <p>Values are represented as <code>hyper</code>.</p> <p>Sequences are represented as <code>hyper</code>[].</p> </li> <li><strong>double</strong> can hold a floating point number. <p>Values are represented as <code>double</code>.</p> <p>Sequences are represented as <code>double</code>[].</p> </li> <li><strong>binary</strong> can hold a sequence of octets. <p>Values are represented as <code>byte</code>[].</p> <p>Sequences are represented as <code>byte</code>[][].</p> </li> </ul> <p>Within templates an additional type <strong>any</strong> can occur. When such a template is used to create a new <a href="SetElement.html">SetElement</a>, the type of the element is initially reported as <code>any</code> (having no value). When the value of such an element is first set, it will assume the type used. </p> <p>If the schema marks a value as <em>nullable</em> (which is indicated by attribute <b>PropertyAttribute::MAYBEVOID</b> ), its contents may be <b>NULL</b>. </p> <p>The configuration should support explicit access to default values (implementing ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertyState.html">XPropertyState</a> and ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertyWithState.html">XPropertyWithState</a>). </p> </dd> <dt><b>See also</b></dt> <dd><a href="ConfigurationProvider.html">ConfigurationProvider</a><br> Root instances of this service can be requested from a <a href="ConfigurationProvider.html">ConfigurationProvider</a>. </dd> <dt><b>See also</b></dt> <dd><a href="ConfigurationUpdateAccess.html">ConfigurationUpdateAccess</a><br> an extended service that includes facilities for modifying configuration data. </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Config/Reading_Configuration_Data">Config - Reading Configuration Data</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Config/Object_Model">Config - Object Model</a></dd> </dl> </td> </tr> </table> <hr> <a name="IncludedServices"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services</td> </tr> <tr> <td class="imsum_left"><a href="HierarchyAccess.html">HierarchyAccess</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>provides interfaces to access child and descendent elements. </dd> <dd><p>An implementation actually implements a specialization of this service, which depends on its <em>Container</em> role. </p> <p>Implementations shall implement exactly one of:</p> <ul> <li><a href="SetAccess.html">SetAccess</a> if this element is a <em>Set</em>.</li> <li><a href="GroupAccess.html">GroupAccess</a> if this element is a <em>Group</em>.</li> </ul> </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="HierarchyElement.html">HierarchyElement</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>provides interfaces to obtain information about this element and its role and context in the hierarchy. </dd> <dd><p>An implementation actually implements a specialization of this service, which depends on its <em>Element</em> role. </p> <p>Implementations shall implement exactly one of:</p> <ul> <li><a href="AccessRootElement.html">AccessRootElement</a> if this element is the <em>Root</em> of the whole hierarchy. Objects that can be created directly by a <a href="ConfigurationProvider.html">ConfigurationProvider</a> implement this service.</li> <li><a href="SetElement.html">SetElement</a> if this element may be contained in a <em>Set</em>.</li> <li><a href="GroupElement.html">GroupElement</a> if this element is a child of a <em>Group</em>.</li> </ul> </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="SetAccess.html">SetAccess</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specializes <a href="HierarchyAccess.html">HierarchyAccess</a>, if this element is a <em>Set</em>. </dd> <dd><p>This is an alternative to <a href="GroupAccess.html">GroupAccess</a>. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="GroupAccess.html">GroupAccess</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specializes <a href="HierarchyAccess.html">HierarchyAccess</a>, if this element is a <em>Group</em>. </dd> <dd><p>This is an alternative to <a href="SetAccess.html">SetAccess</a>. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="AccessRootElement.html">AccessRootElement</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specializes <a href="HierarchyElement.html">HierarchyElement</a>, if this element is the <em>Root</em> of the whole hierarchy. </dd> <dd><p>This is an alternative to <a href="SetElement.html">SetElement</a> or <a href="GroupElement.html">GroupElement</a>. </p> </dd> <dt><b>See also</b></dt> <dd><a href="ConfigurationProvider.html">ConfigurationProvider</a><br> Instances obtained from a <a href="ConfigurationProvider.html">ConfigurationProvider</a> will implement this version of <a href="HierarchyElement.html">HierarchyElement</a>. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="SetElement.html">SetElement</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specializes <a href="HierarchyElement.html">HierarchyElement</a>, if this element may be contained in a <em>Set</em>. </dd> <dd><p>This is an alternative to <a href="AccessRootElement.html">AccessRootElement</a> or <a href="GroupElement.html">GroupElement</a>. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="GroupElement.html">GroupElement</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specializes <a href="HierarchyElement.html">HierarchyElement</a>, if this element is a child of a <em>Group</em>. </dd> <dd><p>This is an alternative to <a href="AccessRootElement.html">AccessRootElement</a> or <a href="SetElement.html">SetElement</a>. </p> </dd> </dl> </td> </tr> </table> <br> <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
>
1906
