offapi/com/sun/star/form/validation/XValidator.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XValidator.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_form_validation_XValidator_idl__
  32 #define __com_sun_star_form_validation_XValidator_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_lang_NullPointerException_idl__
  39 #include <com/sun/star/lang/NullPointerException.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module form { module validation {
  45
  46 interface XValidityConstraintListener;
  47
  48 //=============================================================================
  49
  50 /** specifies a component able to validate (the content of) other components
  51
  52     <p>Validators support simple validity checks and retrieving justifications for
  53     invalidity.</p>
  54
  55     <p>Validators may additionally support dynamic validity constraints. In such a case,
  56     the validity of a given value may change, without the value changing itself.<br/>
  57     To be notified about this, interested components should register as <type>XValidityConstraintListener</type>.
  58
  59     @see XValidatable
  60 */
  61 interface XValidator : com::sun::star::uno::XInterface
  62 {
  63     /** determines whether the given value is valid
  64
  65     @param aValue
  66         the value to check for validity
  67     @return
  68         <TRUE/> if and only if the value is considered valid.
  69     */
  70     boolean isValid( [in] any Value );
  71
  72     /** retrieves a justification for the invalidity of the given value
  73
  74     @param aValue
  75         the value which has been recognized as being invalid
  76     @return
  77         a human-readable string, which explains why the given valus is considered invalid.
  78     */
  79     string explainInvalid( [in] any Value );
  80
  81     /** registers the given validity listener.
  82
  83     <p>Usually, an <type>XValidatable</type> instance will also add itself as validity listener,
  84     as soon as the validator is introduced to it.</p>
  85
  86     <p>Implementations which do not support dynamic validity contraints should simply ignore this
  87     call.</p>
  88
  89     @throws <type scope="com::sun::star::lang">NullPointerException</type>
  90         if the given listener is <NULL/>
  91     @see XValidityConstraintListener
  92     */
  93     void    addValidityConstraintListener( [in] XValidityConstraintListener Listener )
  94                 raises( com::sun::star::lang::NullPointerException );
  95
  96     /** revokes the given validity listener
  97
  98     @throws <type scope="com::sun::star::lang">NullPointerException</type>
  99         if the given listener is <NULL/>
 100     @see XValidityConstraintListener
 101     */
 102     void    removeValidityConstraintListener( [in] XValidityConstraintListener Listener )
 103                 raises( com::sun::star::lang::NullPointerException );
 104 };
 105
 106 //=============================================================================
 107
 108 }; }; }; }; };
 109
 110 #endif