<html> <head> <title>Interface XModel</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="XModel-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">xforms</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XModel</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>represent an XForms model </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="#getID">getID</a></td> <td class="imsum_right">get the XForms model ID </td> </tr> <tr> <td class="imsum_left"><a href="#setID">setID</a></td> <td class="imsum_right">set the XForms model ID </td> </tr> <tr> <td class="imsum_left"><a href="#initialize">initialize</a></td> <td class="imsum_right">initialize the model </td> </tr> <tr> <td class="imsum_left"><a href="#rebuild">rebuild</a></td> <td class="imsum_right">rebuild the model </td> </tr> <tr> <td class="imsum_left"><a href="#recalculate">recalculate</a></td> <td class="imsum_right">re-evaluate all calculate attributes </td> </tr> <tr> <td class="imsum_left"><a href="#revalidate">revalidate</a></td> <td class="imsum_right">re-evaluate all validity attributes </td> </tr> <tr> <td class="imsum_left"><a href="#refresh">refresh</a></td> <td class="imsum_right">refresh the model </td> </tr> <tr> <td class="imsum_left"><a href="#submit">submit</a></td> <td class="imsum_right">submit form through given submission id </td> </tr> <tr> <td class="imsum_left"><a href="#submitWithInteraction">submitWithInteraction</a></td> <td class="imsum_right">submit form through given submission id </td> </tr> <tr> <td class="imsum_left"><a href="#getDataTypeRepository">getDataTypeRepository</a></td> <td class="imsum_right">provides management access to the XSD data types associated with the model </td> </tr> <tr> <td class="imsum_left"><a href="#getInstances">getInstances</a></td> <td class="imsum_right">gets container containing all instances; </td> </tr> <tr> <td class="imsum_left"><a href="#getInstanceDocument">getInstanceDocument</a></td> <td class="imsum_right">retrieves the instance with the given id </td> </tr> <tr> <td class="imsum_left"><a href="#getDefaultInstance">getDefaultInstance</a></td> <td class="imsum_right">get the default instance for this model </td> </tr> <tr> <td class="imsum_left"><a href="#createBinding">createBinding</a></td> <td class="imsum_right">create a binding element for this model </td> </tr> <tr> <td class="imsum_left"><a href="#cloneBinding">cloneBinding</a></td> <td class="imsum_right">clone an arbitrary binding element for this model; still needs </td> </tr> <tr> <td class="imsum_left"><a href="#getBinding">getBinding</a></td> <td class="imsum_right">get a binding with a certain ID </td> </tr> <tr> <td class="imsum_left"><a href="#getBindings">getBindings</a></td> <td class="imsum_right">get a container containing all bindings; also supports XNameAccess </td> </tr> <tr> <td class="imsum_left"><a href="#createSubmission">createSubmission</a></td> <td class="imsum_right">create a submission element for this model </td> </tr> <tr> <td class="imsum_left"><a href="#cloneSubmission">cloneSubmission</a></td> <td class="imsum_right">clone an arbitrary submission element for this model </td> </tr> <tr> <td class="imsum_left"><a href="#getSubmission">getSubmission</a></td> <td class="imsum_right">get a submission with a certain ID. </td> </tr> <tr> <td class="imsum_left"><a href="#getSubmissions">getSubmissions</a></td> <td class="imsum_right">get container containing all submissions; also supports XNameAccess </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="getID" class="membertitle">getID</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>getID</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>get the XForms model ID </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setID" class="membertitle">setID</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>setID</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> id );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>set the XForms model ID </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="initialize" class="membertitle">initialize</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>initialize</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>initialize the model </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="rebuild" class="membertitle">rebuild</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>rebuild</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>rebuild the model </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="recalculate" class="membertitle">recalculate</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>recalculate</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>re-evaluate all calculate attributes </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="revalidate" class="membertitle">revalidate</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>revalidate</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>re-evaluate all validity attributes </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="refresh" class="membertitle">refresh</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>refresh</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>refresh the model </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="submit" class="membertitle">submit</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>submit</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> id )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/VetoException.html">VetoException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>submit form through given submission id </dd> <dd><p>This is a convenience method. Calling it is equivalent to calling <code><a href="#getSubmission">getSubmission</a>( <arg>id</arg> ).submit()</code>.</p> </dd> <dt><b>Parameter id</b></dt> <dd>the ID of the submission to execute </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::util::VetoException when the current model state does not allow a submission. Usually, this indicates that consistency criteria for the model data is not fulfilled. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException when another error occured during the submission. The ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a>::<a href="../lang/WrappedTargetException.html#TargetException">TargetException</a> describes this error then. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="submitWithInteraction" class="membertitle">submitWithInteraction</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>submitWithInteraction</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> id,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XInteractionHandler.html">XInteractionHandler</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="../util/module-ix.html">util</a>::<a href="../util/VetoException.html">VetoException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>submit form through given submission id </dd> <dd><p>This is a convenience method. Calling it is equivalent to calling <code><a href="#getSubmission">getSubmission</a>( <arg>id</arg>, <arg>handler</arg> ).submit()</code>.</p> </dd> <dt><b>Parameter id</b></dt> <dd>the ID of the submission to execute </dd> <dt><b>Parameter aHandler</b></dt> <dd>This handler allows additional user interaction, which may be necessary before the submission can be performed. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::util::VetoException when the current model state does not allow a submission. Usually, this indicates that consistency criteria for the model data is not fulfilled. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException when another error occured during the submission. The ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/WrappedTargetException.html">WrappedTargetException</a>::<a href="../lang/WrappedTargetException.html#TargetException">TargetException</a> describes this error then. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDataTypeRepository" class="membertitle">getDataTypeRepository</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="XDataTypeRepository.html">XDataTypeRepository</a></td> </tr> <tr> <td valign="top"><b>getDataTypeRepository</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>provides management access to the XSD data types associated with the model </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getInstances" class="membertitle">getInstances</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">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XSet.html">XSet</a></td> </tr> <tr> <td valign="top"><b>getInstances</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets container containing all instances; </dd> <dd><p>The elements of the set are arrays of ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a>s, containing the ID, the URL, and the instance itself.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getInstanceDocument" class="membertitle">getInstanceDocument</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">::com::sun::star::xml::<a href="../xml/dom/module-ix.html">dom</a>::<a href="../xml/dom/XDocument.html">XDocument</a></td> </tr> <tr> <td valign="top"><b>getInstanceDocument</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> id );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves the instance with the given id </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDefaultInstance" class="membertitle">getDefaultInstance</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">::com::sun::star::xml::<a href="../xml/dom/module-ix.html">dom</a>::<a href="../xml/dom/XDocument.html">XDocument</a></td> </tr> <tr> <td valign="top"><b>getDefaultInstance</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>get the default instance for this model </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createBinding" class="membertitle">createBinding</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">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> </tr> <tr> <td valign="top"><b>createBinding</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>create a binding element for this model </dd> <dd><p>The returned binding still needs to be inserted into the bindings container.</p> </dd> <dt><b>See also</b></dt> <dd><a href="#getBindings">getBindings</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="cloneBinding" class="membertitle">cloneBinding</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">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> </tr> <tr> <td valign="top"><b>cloneBinding</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> <td valign="bottom"> binding );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>clone an arbitrary binding element for this model; still needs </dd> <dd><p>The returned binding still needs to be inserted into the bindings container.</p> </dd> <dt><b>See also</b></dt> <dd><a href="#getBindings">getBindings</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getBinding" class="membertitle">getBinding</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">::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> </tr> <tr> <td valign="top"><b>getBinding</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> id );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>get a binding with a certain ID </dd> <dd><p>This is a convenience method: the same result can also be obtained through <a href="#getBindings">getBindings</a></p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getBindings" class="membertitle">getBindings</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">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XSet.html">XSet</a></td> </tr> <tr> <td valign="top"><b>getBindings</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>get a container containing all bindings; also supports XNameAccess </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createSubmission" class="membertitle">createSubmission</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="XSubmission.html">XSubmission</a></td> </tr> <tr> <td valign="top"><b>createSubmission</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>create a submission element for this model </dd> <dd><p>The returned submission element still needs to be inserted into the submission container.</p> </dd> <dt><b>See also</b></dt> <dd><a href="#getSubmissions">getSubmissions</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="cloneSubmission" class="membertitle">cloneSubmission</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="XSubmission.html">XSubmission</a></td> </tr> <tr> <td valign="top"><b>cloneSubmission</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/XPropertySet.html">XPropertySet</a></td> <td valign="bottom"> submission );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>clone an arbitrary submission element for this model </dd> <dd><p>The returned submission element still needs to be inserted into the submission container.</p> </dd> <dt><b>See also</b></dt> <dd><a href="#getSubmissions">getSubmissions</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSubmission" class="membertitle">getSubmission</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="XSubmission.html">XSubmission</a></td> </tr> <tr> <td valign="top"><b>getSubmission</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> id );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>get a submission with a certain ID. </dd> <dd><p>This is a convenience method: the same result can also be obtained through <a href="#getSubmissions">getSubmissions</a>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getSubmissions" class="membertitle">getSubmissions</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">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XSet.html">XSet</a></td> </tr> <tr> <td valign="top"><b>getSubmissions</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>get container containing all submissions; also supports XNameAccess </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
fc480f9d5aabed8eeaffe8ad3401a94c
>
files
>
8185
