/**
    * Copyright 2005-2007 the original author or authors.
    *
    * Licensed under the Gnu General Pubic 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.opensource.org/licenses/gpl-license.php
    *
   * This program 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 General Public License for more details.
   */
  package org.figure8.join.control.form;
  
  import org.figure8.join.control.JoinForm;
  import org.figure8.join.control.action.ParameterValueActions;
  
  import org.apache.struts.action.ActionMapping;
  
  import javax.servlet.http.HttpServletRequest;
  
  import java.util.Map;
  import java.util.HashMap;
  /**
   * Form object to manage parameters values into Join application. 
   * @author <a href="mailto:jerome.evrard@gmail.com">Jerome Evrard</a>
   * @version $Revision: 1.3 $
   * 
   * @struts.form name="parameterValueForm"
   */
  public class ParameterValueForm extends JoinForm{
  
     // Attributes ---------------------------------------------------------------
  
     /** Edited parameter value */
     private String value;
     /** Edited parameter name */
     private String parameterName;
  
  
     /** Edited environment name */
     private String editedEnvironment;
     /** Edited target name */
     private String editedTarget;
  
     /** Viewed environment name */
     private String viewedEnvironment;
     /** Viewed target name */
     private String viewedTarget;
     /** Render parameters values */
     private boolean render;
  
     /**
      * The map of values in form to copy. Keys are the id of value,
      * values are boolean telling if value is selected to copy.
      */
     private Map copiedValue = new HashMap();
  
  
     // Public -------------------------------------------------------------------
  
     /** @return Returns the value. */
     public String getValue(){
        return value;
     }
     /** @param value The value to set. */
     public void setValue(String value){
        this.value = value;
     }
     /** @return Returns the parameter. */
     public String getParameterName(){
        return parameterName;
     }
     /** @param parameterName The parameter to set. */
     public void setParameterName(String parameterName){
        this.parameterName = parameterName;
     }
  
     /** @return Returns the editedEnvironment. */
     public String getEditedEnvironment(){
        return editedEnvironment;
     }
     /** @param editedEnvironment The editedEnvironment to set. */
     public void setEditedEnvironment(String editedEnvironment){
        this.editedEnvironment = editedEnvironment;
     }
     /** @return Returns the editedTarget. */
     public String getEditedTarget(){
        return editedTarget;
     }
     /** @param editedTarget The editedTarget to set. */
     public void setEditedTarget(String editedTarget){
        this.editedTarget = editedTarget;
     }
  
     /** @return Returns the viewedEnvironment. */
     public String getViewedEnvironment(){
       return viewedEnvironment;
    }
    /** @param viewedEnvironment The viewedEnvironment to set. */
    public void setViewedEnvironment(String viewedEnvironment){
       this.viewedEnvironment = viewedEnvironment;
    }
    /** @return Returns the viewedTarget. */
    public String getViewedTarget(){
       return viewedTarget;
    }
    /** @param viewedTarget The viewedTarget to set. */
    public void setViewedTarget(String viewedTarget){
       this.viewedTarget = viewedTarget;
    }
    /** @return Returns the render. */
    public boolean isRender(){
       return render;
    }
    /** @param render The render to set. */
    public void setRender(boolean render){
       this.render = render;
    }
 
    /** @return Get the map of values to copy. */
    public Map getCopiedValuesMap(){
       return copiedValue;
    }
    /**
     * Set if a value is selected for copy.
     * @param key The value id.
     * @param value "on" if value is selected
     */
    public void setCopiedValue(String key, Object value){
       copiedValue.put(key, value);
    }
    /**
     * Get "on" if the value is selected for copy.
     * @param key The value id.
     * @return "on" if values is selcted, else null.
     */
    public Object getCopiedValue(String key){
       return copiedValue.get(key);
    }
 
    
    // Override of JoinForm -----------------------------------------------------
    
    /**
     * Validation of the form attributes.
     * @param operation String representing the operation to invoke on Action
     * @param mapping Mapping between forwards name and path for this action
     * @param request The servlet container request wrapper
     */
    public void doValidate(String operation, ActionMapping mapping, HttpServletRequest request) {
       // Validate attributes depending on operation.
       if (ParameterValueActions.LOAD_OP.equals(operation) || ParameterValueActions.DELETE_OP.equals(operation)){
          // Check and see if idenitifier is missing.
          validateEntityObjectId();
       }
       else if (ParameterValueActions.SAVE_OP.equals(operation)){
          // Check and see if edited target is missing.
          if (editedTarget == null || editedTarget.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.deployment.target"));
          // Check and see if edited environment is missing.
          if (editedEnvironment == null || editedEnvironment.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.physicalenv"));
          // Check and see if value is missing.
          if (value == null || value.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.parametervalue"));
          // Check and see if parameter name is missing.
          if (parameterName == null || parameterName.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.parameter"));
       }
       else if (ParameterValueActions.SHOW_VALUES_OP.equals(operation)){
          // Check and see if viewed target is missing.
          if (viewedTarget == null || viewedTarget.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.deployment.target"));
          // Check and see if viewed environment is missing.
          if (viewedEnvironment == null || viewedEnvironment.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.physicalenv"));
       }
       else if (ParameterValueActions.PASTE_VALUES_OP.equals(operation)){
          // Check and see if edited target is missing.
          if (editedTarget == null || editedTarget.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.deployment.target"));
          // Check and see if edited environment is missing.
          if (editedEnvironment == null || editedEnvironment.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.physicalenv"));
       }
    }
 }