<html> <head> <title>Interface XSchema</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="XSchema-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 XSchema</td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>Handles access to the elements of a component schema, i.e its templates and its component definition. </dd> <dt><b>Since </b></dt> <dd>OOo 1.1.2</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="#readSchema">readSchema</a></td> <td class="imsum_right">Describes the full schema (templates + component) to a <a href="XSchemaHandler.html">XSchemaHandler</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#readComponent">readComponent</a></td> <td class="imsum_right">Describes only the component definition to a <a href="XSchemaHandler.html">XSchemaHandler</a>. </td> </tr> <tr> <td class="imsum_left"><a href="#readTemplates">readTemplates</a></td> <td class="imsum_right">Describes the component templates to a <a href="XSchemaHandler.html">XSchemaHandler</a>. </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="readSchema" class="membertitle">readSchema</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>readSchema</b>(</td> <td valign="top">[in] <a href="XSchemaHandler.html">XSchemaHandler</a></td> <td valign="bottom"> aHandler )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/NullPointerException.html">NullPointerException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a>,<br> <a href="MalformedDataException.html">MalformedDataException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Describes the full schema (templates + component) to a <a href="XSchemaHandler.html">XSchemaHandler</a>. </dd> <dt><b>Parameter aHandler</b></dt> <dd>schema handler that will receive calls describing the contents of the templates and the component definition </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::NullPointerException if a <b>NULL</b> handler is passed. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or if a subsequent call to any of the <a href="XSchema.html">XSchema</a>methods is made. The elements of a component schema are only parsed once,a repeat call leads to exception. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the <a href="XSchemaHandler.html">XSchemaHandler</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="readComponent" class="membertitle">readComponent</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>readComponent</b>(</td> <td valign="top">[in] <a href="XSchemaHandler.html">XSchemaHandler</a></td> <td valign="bottom"> aHandler )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/NullPointerException.html">NullPointerException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a>,<br> <a href="MalformedDataException.html">MalformedDataException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Describes only the component definition to a <a href="XSchemaHandler.html">XSchemaHandler</a>. </dd> <dt><b>Parameter aHandler</b></dt> <dd>schema handler that will receive calls describing the contents of the component definition </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::NullPointerException if a <b>NULL</b> handler is passed. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or if a subsequent call to any of the <a href="XSchema.html">XSchema</a>methods is made. The elements of a component schema are only parsed once,a repeat call leads to exception. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the <a href="XSchemaHandler.html">XSchemaHandler</a>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="readTemplates" class="membertitle">readTemplates</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>readTemplates</b>(</td> <td valign="top">[in] <a href="XSchemaHandler.html">XSchemaHandler</a></td> <td valign="bottom"> aHandler )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/NullPointerException.html">NullPointerException</a>,<br> ::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/WrappedTargetException.html">WrappedTargetException</a>,<br> <a href="MalformedDataException.html">MalformedDataException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Describes the component templates to a <a href="XSchemaHandler.html">XSchemaHandler</a>. </dd> <dt><b>Parameter aHandler</b></dt> <dd>schema handler that will receive calls describing the contents of the templates </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::NullPointerException if a <b>NULL</b> handler is passed. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or if a subsequent call to any of the <a href="XSchema.html">XSchema</a>methods is made. The elements of a component schema are only parsed once,a repeat call leads to exception. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the <a href="XSchemaHandler.html">XSchemaHandler</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 © 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>
