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 for ValidationResult>
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 class ValidationResult
33  {
34      // Constants ---------------------------------------------------------------
35      public static final ValidationResult VALID_RESULT = new ValidationResult();
36      
37      // Data members ------------------------------------------------------------
38      private boolean mIsValid;
39      private String mErrorMessage;
40      private Object mReferenceObject;
41      
42      // Constructors ------------------------------------------------------------
43      
44      /*** Creates a new instance of ValidationResult.
45       */
46      protected ValidationResult()
47      {
48          mIsValid = true;
49      }
50      
51      /*** Creates a new instance of ValidationResult that represents a failed
52       * validation with the provided error message.
53       */
54      public ValidationResult(Object referenceObject, String errorMessage)
55      {
56          mIsValid = false;
57          mReferenceObject = referenceObject;
58          mErrorMessage = errorMessage;
59      }
60      
61      // Access methods ----------------------------------------------------------
62      
63      /*** 
64       * Access method that returns true when the data was succesfully validated.
65       */
66      public boolean isValid()
67      {
68          return mIsValid;
69      }
70      
71      /*** 
72       * Access method that returns an end-user displayabla validation message
73       * for validtions that failed. Returns null is the validation was succesfull.
74       */
75      public String getDisplayMessage()
76      {
77          return mErrorMessage;
78      }
79      
80      /***
81       * Access method that returns the refernce object. The reference object is 
82       * typically an field or entity descriptor that can be used to map the
83       * failed validation to for example an on-screen component.
84       */
85      public Object getReferenceObject()
86      {
87          return mReferenceObject;
88      }
89  }