<html> <head> <title>Interface XSubmission</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="XSubmission-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">form</a> :: <a href="module-ix.html" class="namechain">submission</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 XSubmission</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>is implemented by components which support submitting data. </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="#submit">submit</a></td> <td class="imsum_right">tells the component to submit data </td> </tr> <tr> <td class="imsum_left"><a href="#submitWithInteraction">submitWithInteraction</a></td> <td class="imsum_right">tells the component to submit data </td> </tr> <tr> <td class="imsum_left"><a href="#addSubmissionVetoListener">addSubmissionVetoListener</a></td> <td class="imsum_right">registers the given listener to be notified when a submission occurs </td> </tr> <tr> <td class="imsum_left"><a href="#removeSubmissionVetoListener">removeSubmissionVetoListener</a></td> <td class="imsum_right">revokes a listener which has previously been registered to be notified when a submission occurs </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="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> </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>tells the component to submit data </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::util::VetoException if the submission has been vetoed. Usually, this indicates that not all requirements for the submission, e.g. data consistency, are fulfilled. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occured during invoking the submission target </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] ::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>tells the component to submit data </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 if the submission has been vetoed. Usually, this indicates that not all requirements for the submission, e.g. data consistency, are fulfilled. </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::WrappedTargetException if an error occured during invoking the submission target </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addSubmissionVetoListener" class="membertitle">addSubmissionVetoListener</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>addSubmissionVetoListener</b>(</td> <td valign="top">[in] <a href="XSubmissionVetoListener.html">XSubmissionVetoListener</a></td> <td valign="bottom"> listener )</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/NoSupportException.html">NoSupportException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>registers the given listener to be notified when a submission occurs </dd> <dt><b>Parameter listener</b></dt> <dd>the listener to register </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::NoSupportException when the component does not support external componentsw vetoing the submission </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeSubmissionVetoListener" class="membertitle">removeSubmissionVetoListener</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>removeSubmissionVetoListener</b>(</td> <td valign="top">[in] <a href="XSubmissionVetoListener.html">XSubmissionVetoListener</a></td> <td valign="bottom"> listener )</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/NoSupportException.html">NoSupportException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>revokes a listener which has previously been registered to be notified when a submission occurs </dd> <dt><b>Parameter listener</b></dt> <dd>the listener to revoke </dd> <dt><b>Throws</b></dt> <dd>com::sun::star::lang::NoSupportException when the component does not support external componentsw vetoing the submission </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>