View Javadoc

1   /* (c) Copyright 2003 Caleigo AB, All rights reserved. 
2    * 
3    * This library is free software; you can redistribute it and/or
4    * modify it under the terms of the GNU Lesser General Public
5    * License as published by the Free Software Foundation; either
6    * version 2.1 of the License, or (at your option) any later version.
7    * 
8    * This library is distributed in the hope that it will be useful,
9    * but WITHOUT ANY WARRANTY; without even the implied warranty of
10   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11   * Lesser General Public License for more details.
12   * 
13   * You should have received a copy of the GNU Lesser General Public
14   * License along with this library; if not, write to the Free Software
15   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16   *  
17   */
18  
19  package org.caleigo.core;
20  
21  /*** <Description of IDataValidator>
22   *
23   * @author  Dennis Zikovic
24   * @version 1.00
25   *
26   *//*
27   *
28   * WHEN        WHO               WHY & WHAT
29   * ------------------------------------------------------------------------------
30   * 2002-09-11  Dennis Zikovic    Creation
31   */
32  public interface IDataValidator
33  {
34      // Methods -----------------------------------------------------------------
35      
36      /*** This method returns true if the called IDataValidator can validate
37       * data in the context of the provided IDataProvider object.
38       */
39      public boolean canValidate(IDataProvider dataProvider);
40      
41      /*** This method returns true if the provided data is valid in the context 
42       * of the provided IDataProvider object.
43       */
44      public boolean isDataValid(Object data, IDataProvider dataProvider);
45      
46      /*** Returs an end-user displayable text describing the failed validation.
47       */
48      public String getInvalidMessage(Object data, IDataProvider dataProvider);
49  }