INTEGRATION: CWS frmvalidation (1.1.2); FILE ADDED

2004/03/12 11:23:21 fs 1.1.2.1: mass checkin - validation support for form control( model)s

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

@@ -0,0 +1,141 @@
+/*************************************************************************
+ *
+ *  $RCSfile: XValidator.idl,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2004-04-02 10:40:27 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef __com_sun_star_form_validation_XValidator_idl__
+#define __com_sun_star_form_validation_XValidator_idl__
+
+#ifndef __com_sun_star_uno_XInterface_idl__
+#include <com/sun/star/uno/XInterface.idl>
+#endif
+
+#ifndef __com_sun_star_lang_NullPointerException_idl__
+#include <com/sun/star/lang/NullPointerException.idl>
+#endif
+
+//=============================================================================
+
+module com {  module sun {  module star {  module form { module validation {
+
+interface XValidityConstraintListener;
+
+//=============================================================================
+
+/** specifies a component able to validate (the content of) other components
+
+    <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 <type>XValidityConstraintListener</type>.
+
+    @see XValidatable
+*/
+interface XValidator : com::sun::star::uno::XInterface
+{
+    /** determines whether the given value is valid
+
+    @param aValue
+        the value to check for validity
+    @return
+        <TRUE/> if and only if the value is considered valid.
+    */
+    boolean isValid( [in] any Value );
+
+    /** retrieves a justification for the invalidity of the given value
+
+    @param aValue
+        the value which has been recognized as being invalid
+    @return
+        a human-readable string, which explains why the given valus is considered invalid.
+    */
+    string explainInvalid( [in] any Value );
+
+    /** registers the given validity listener.
+
+    <p>Usually, an <type>XValidatable</type> 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>
+
+    @throws <type scope="com::sun::star::lang">NullPointerException</type>
+        if the given listener is <NULL/>
+    @see XValidityConstraintListener
+    */
+    void    addValidityConstraintListener( [in] XValidityConstraintListener Listener )
+                raises( com::sun::star::lang::NullPointerException );
+
+    /** revokes the given validity listener
+
+    @throws <type scope="com::sun::star::lang">NullPointerException</type>
+        if the given listener is <NULL/>
+    @see XValidityConstraintListener
+    */
+    void    removeValidityConstraintListener( [in] XValidityConstraintListener Listener )
+                raises( com::sun::star::lang::NullPointerException );
+};
+
+//=============================================================================
+
+}; }; }; }; };
+
+#endif