| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #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 |