/*
    * Copyright (c) 2001 - 2005 ivata limited.
    * All rights reserved.
    * -----------------------------------------------------------------------------
    * ivata masks may be redistributed under the GNU General Public
    * License as published by the Free Software Foundation;
    * version 2 of the License.
    *
    * These programs are free software; you can redistribute them and/or
   * modify them under the terms of the GNU General Public License
   * as published by the Free Software Foundation; version 2 of the License.
   *
   * These programs are distributed in the hope that they will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   *
   * See the GNU General Public License in the file LICENSE.txt for more
   * details.
   *
   * If you would like a copy of the GNU General Public License write to
   *
   * Free Software Foundation, Inc.
   * 59 Temple Place - Suite 330
   * Boston, MA 02111-1307, USA.
   *
   *
   * To arrange commercial support and licensing, contact ivata at
   *                  http://www.ivata.com/contact.jsp
   * -----------------------------------------------------------------------------
   * $Log: ValidationError.java,v $
   * Revision 1.4  2005/04/09 18:04:16  colinmacleod
   * Changed copyright text to GPL v2 explicitly.
   *
   * Revision 1.3  2005/03/10 10:23:50  colinmacleod
   * Added bundle, errorKey and param.
   *
   * Revision 1.2  2005/01/06 22:13:22  colinmacleod
   * Moved up a version number.
   * Changed copyright notices to 2005.
   * Updated the documentation:
   *   - started working on multiproject:site docu.
   *   - changed the logo.
   * Added checkstyle and fixed LOADS of style issues.
   * Added separate thirdparty subproject.
   * Added struts (in web), util and webgui (in webtheme) from ivata op.
   *
   * Revision 1.1  2004/12/29 20:07:06  colinmacleod
   * Renamed subproject masks to mask.
   *
   * Revision 1.1.1.1  2004/05/16 20:40:32  colinmacleod
   * Ready for 0.1 release
   *
   * Revision 1.3  2004/03/21 21:16:23  colinmacleod
   * Shortened name to ivata op.
   *
   * Revision 1.2  2004/02/01 22:07:29  colinmacleod
   * Added full names to author tags
   *
   * Revision 1.1  2004/01/29 13:48:41  janboros
   * Moved ivata op to SourceForge
   *
   * Revision 1.1  2003/10/16 07:27:45  colin
   * caming to repository
   *
   * Revision 1.4  2003/02/24 19:08:17  colin
   * *** empty log message ***
   *
   * Revision 1.3  2003/02/20 20:24:11  colin
   * improved validation by adding ValidationField and ValidationException
   *
   * Revision 1.2  2003/02/04 17:36:47  colin
   * copyright notice
   *
   * Revision 1.1  2002/11/12 10:40:47  colin
   * first version in CVS. encapsulates Struts class ActionError
   * and passes resource keys from server-side to client-side
   * -----------------------------------------------------------------------------
   */
  package com.ivata.mask.validation;
  import java.io.Serializable;
  import java.util.List;
  import com.ivata.mask.field.Field;
  /***
   * <p>
   * This class represents an error which occurred when data is validated for
   * submission.
   * </p>
   *
   * <p>
   * Before new data is posted to <i>ivata masks </i>, it is possible to validate
   * it. If the data is for any reason invalid, then an instance of this class is
   * created to indicate what is wrong or missing ind the data (invalid date
   * format? missing parameter?). Multiple errors which occur can be grouped
   * together in a <code>ValidationErrors</code> instance.
   * </p>
   *
   * <p>
   * This class originally appeared as part of <a
   * href="http://www.ivata.org">ivata op </a> and <a
  * href="http://www.ivata.com/portal">ivata team portal </a>.
  * </p>.
  *
  * @since ivata masks 0.4 (2002-11-11)
  * @author Colin MacLeod
  * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
  * @version $Revision: 1.4 $
  * @see ValidationErrors
  * @see org.apache.struts.action.ActionError
  */
 public class ValidationError implements Serializable {
     /***
      * Refer to {@link #getBundle}.
      */
     private String bundle;
     /***
      * <p>
      * Label key of the error which occurred.
      * </p>
      */
     private String errorKey;
     /***
      * <p>
      * Field which caused this error.
      * </p>
      */
     private Field field;
     /***
      * <p>
      * A list of error string parameters. Depending on the value of
      * <code>key</code>, there may be many parameters describing the error in
      * detail. This attribute may be <code>null</code> if there are no
      * parameters required.
      * </p>
      */
     private List parameters = null;
     /***
      * Refer to {@link #getResourceFieldPath}.
      */
     private String resourceFieldPath;
     /***
      * <p>
      * Create a new instance with the given error key and parameters.
      * Attributes of
      * this class are <i>immutable </i> so the values specified here cannot be
      * later altered.
      * </p>
      *
      * @param errorKeyParam
      *            label key of the error which occurred.
      * @param parametersParam
      *            list of error string parameters, used to completed the error
      *            message. This attribute may be
      *            <code>null</code> if there are no parameters required..
      */
     public ValidationError(
             final String errorKeyParam,
             final List parametersParam) {
         this(null, null, null, errorKeyParam,
                 parametersParam);
     }
     /***
      * <p>
      * Create a new instance with the given field, and error key.
      * Attributes of this class are <i>immutable </i> so the values
      * specified here cannot be later altered.
      * </p>
      *
      * @param fieldParam
      *            field which contained an invalid value and caused the error.
      * @param errorKeyParam
      *            key of the error which occurred.
      */
     public ValidationError(
             final String resourceFieldPathParam,
             final Field fieldParam, final String errorKeyParam) {
         this(resourceFieldPathParam, null, fieldParam, errorKeyParam, null);
     }
     /***
      * <p>
      * Create a new instance with the given field and parameters. Attributes of
      * this class are <i>immutable </i> so the values specified here cannot be
      * later altered.
      * </p>
      *
      * @param resourceFieldPathParam
      * Refer to {@link #getResourceFieldPathParam}.
      * @param fieldParam
      *            field which contained an invalid value and caused the error.
      * @param errorKeyParam
      *            label key of the error which occurred.
      * @param parametersParam
      *            list of error string parameters, used to completed the error
      *            message. This attribute may be
      *            <code>null</code> if there are no parameters required..
      */
     public ValidationError(
             final String resourceFieldPathParam,
             final Field fieldParam,
             final String errorKeyParam,
             final List parametersParam) {
         this(resourceFieldPathParam, null, fieldParam, errorKeyParam,
                 parametersParam);
     }
     /***
      * <p>
      * Create a new instance with the given field, error key and
      * bundle. Attributes of this class are <i>immutable </i> so the values
      * specified here cannot be later altered.
      * </p>
      *
      * @param bundle
      * Refer to {@link #getBundle}.
      * @param resourceFieldPathParam
      * Refer to {@link #getResourceFieldPathParam}.
      * @param fieldParam
      *            field which contained an invalid value and caused the error.
      * @param errorKeyParam
      *            key of the error which occurred.
      */
     public ValidationError(
             final String resourceFieldPathParam,
             final String bundle,
             final Field fieldParam,
             final String errorKeyParam
             ) {
         this(resourceFieldPathParam, bundle, fieldParam, errorKeyParam, null);
     }
     /***
      * <p>
      * Create a new instance with the given bundle, field, label and parameters.
      * Attributes of this class are <i>immutable </i> so the values specified
      * here cannot be later altered.
      * </p>
      *
      * @param bundle
      * Refer to {@link #getBundle}.
      * @param resourceFieldPathParam
      * Refer to {@link #getResourceFieldPathParam}.
      * @param fieldParam
      *            field which contained an invalid value and caused the error.
      * @param errorKeyParam
      *            label key of the error which occurred.
      * @param parametersParam
      *            list of error string parameters. This attribute may be
      *            <code>null</code> if there are no parameters required..
      */
     public ValidationError(
             final String resourceFieldPathParam,
             final String bundle,
             final Field fieldParam,
             final String errorKeyParam,
             final List parametersParam
             ) {
         this.resourceFieldPath = resourceFieldPathParam;
         this.bundle = bundle;
         this.field = fieldParam;
         this.errorKey = errorKeyParam;
         this.parameters = parametersParam;
     }
 
     /***
      * Get the message resource bundle associated with this error. May be
      * <code>null</code>.
      *
      * @return message resource used to localize the field name for this error.
      */
     public String getBundle() {
         return bundle;
     }
     /***
      * <p>
      * Message key of the error which occurred, from the error message
      * resources.
      * </p>
      *
      * @return message key describing the error.
      */
     public final String getErrorKey() {
         return errorKey;
     }
     /***
      * <p>
      * Get the field which contained an invalid value and caused the error.
      * </p>
      *
      * @return the current value of field.
      */
     public final Field getField() {
         return field;
     }
     /***
      * <p>
      * A list of error string parameters. Depending on the value of
      * <code>key</code>, there may be many parameters describing the error in
      * detail. This attribute may be <code>null</code> if there are no
      * parameters required.
      * </p>
      *
      * @return the current value of parameters.
      */
     public final List getParameters() {
         return parameters;
     }
     /***
      * <p>
      * Get the message resources field path associated with this field. This is
      * the first part of the path used to search for string in the localization
      * bundle.
      * </p>
      *
      * @return message resource field path.
      */
     public String getResourceFieldPath() {
         return resourceFieldPath;
     }
     /***
      * Overridden from <code>Object</code> for convenience when debugging.
      *
      * @return the class name followed by key, field and parameters.
      */
     public final String toString() {
         StringBuffer errorString = new StringBuffer();
         errorString.append(getClass().getName());
         errorString.append("[field[");
         errorString.append(field);
         errorString.append("]:key[");
         errorString.append(errorKey);
         errorString.append("]:parameters");
         errorString.append(parameters);
         errorString.append("]");
         return errorString.toString();
     }
 }