<html> <head> <title>Interface XValidator</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="XValidator-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">validation</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 XValidator</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies a component able to validate (the content of) other components </dd> <dd><p>Validators support simple validity checks and retrieving justifications for invalidity.</p> <p>Validators may additionally support dynamic validity constraints. In such a case, the validity of a given value may change, without the value changing itself.<br/> To be notified about this, interested components should register as <a href="XValidityConstraintListener.html">XValidityConstraintListener</a>. </dd> <dt><b/></dt> <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="#isValid">isValid</a></td> <td class="imsum_right">determines whether the given value is valid </td> </tr> <tr> <td class="imsum_left"><a href="#explainInvalid">explainInvalid</a></td> <td class="imsum_right">retrieves a justification for the invalidity of the given value </td> </tr> <tr> <td class="imsum_left"><a href="#addValidityConstraintListener">addValidityConstraintListener</a></td> <td class="imsum_right">registers the given validity listener. </td> </tr> <tr> <td class="imsum_left"><a href="#removeValidityConstraintListener">removeValidityConstraintListener</a></td> <td class="imsum_right">revokes the given validity listener </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="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> <td valign="top">[in] any</td> <td valign="bottom"> Value );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines whether the given value is valid </dd> <dt><b>Parameter aValue</b></dt> <dd>the value to check for validity </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if and only if the value is considered valid. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="explainInvalid" class="membertitle">explainInvalid</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>explainInvalid</b>(</td> <td valign="top">[in] any</td> <td valign="bottom"> Value );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>retrieves a justification for the invalidity of the given value </dd> <dt><b>Parameter aValue</b></dt> <dd>the value which has been recognized as being invalid </dd> <dt><b>Returns</b></dt> <dd>a human-readable string, which explains why the given valus is considered invalid. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addValidityConstraintListener" class="membertitle">addValidityConstraintListener</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>addValidityConstraintListener</b>(</td> <td valign="top">[in] <a href="XValidityConstraintListener.html">XValidityConstraintListener</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/NullPointerException.html">NullPointerException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>registers the given validity listener. </dd> <dd><p>Usually, an <a href="XValidatable.html">XValidatable</a> instance will also add itself as validity listener, as soon as the validator is introduced to it.</p> <p>Implementations which do not support dynamic validity contraints should simply ignore this call.</p> </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/NullPointerException.html">NullPointerException</a> if the given listener is <b>NULL</b> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeValidityConstraintListener" class="membertitle">removeValidityConstraintListener</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>removeValidityConstraintListener</b>(</td> <td valign="top">[in] <a href="XValidityConstraintListener.html">XValidityConstraintListener</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/NullPointerException.html">NullPointerException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>revokes the given validity listener </dd> <dt><b>Throws</b></dt> <dd>::com::sun::star::<a href="../../lang/module-ix.html">lang</a>::<a href="../../lang/NullPointerException.html">NullPointerException</a> if the given listener is <b>NULL</b> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2009 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>