/**
    * Copyright 2005-2006 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.EnvironmentMappingActions;
  
  import org.apache.struts.action.ActionMapping;
  
  import javax.servlet.http.HttpServletRequest;
  
  import java.util.Date;
  /**
   * Form object used for manipulating environment mappings into Join application.
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.1 $
   *
   * @struts.form name="envMappingForm"
   */
  public class EnvironmentMappingForm extends JoinForm{
  
     // Attributes ---------------------------------------------------------------
  
     /** The unique key of logical environment this maping is for */
     private String logicalEnvKey;
     /** The unique key of physical environment this mapping is for */
     private String physicalEnvKey;
     /** The starting date of this environmnent mapping */
     private Date startDate;
     /** The end date of this environment mapping */
     private Date endDate;
  
  
     // Constructors -------------------------------------------------------------
  
     /** Creates a new instance of EnvironmentMappingForm */
     public EnvironmentMappingForm(){
     }
  
  
     // Public -------------------------------------------------------------------
  
     /** @return The unique key of logical environment of this mapping */
     public String getLogicalEnvKey(){
        return logicalEnvKey;
     }
     /** @param logicalEnvKey The unique key of logical environment of this mapping */
     public void setLogicalEnvKey(String logicalEnvKey){
        this.logicalEnvKey = logicalEnvKey;
     }
  
     /** @return The unique key of physical environment of this mapping */
     public String getPhysicalEnvKey(){
        return physicalEnvKey;
     }
     /** @param physicalEnvKey The unique key of physical environment of this mapping */
     public void setPhysicalEnvKey(String physicalEnvKey){
        this.physicalEnvKey = physicalEnvKey;
     }
  
     /** @return The starting date of this environmnent mapping */
     public Date getStartDate(){
        return startDate;
     }
     /** @param startDate The starting date of this environmnent mapping */
     public void setStartDate(Date startDate){
        this.startDate = startDate;
     }
  
     /** @return The end date of this environment mapping */
     public Date getEndDate(){
        return endDate;
     }
     /** @param endDate The end date of this environment mapping */
     public void setEndDate(Date endDate){
        this.endDate = endDate;
     }
  
  
     // Implementation of JoinForm -----------------------------------------------
  
     /**
      * Validate form attributes depending on requested operation.
      * @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){
 
       if (EnvironmentMappingActions.LOAD_OP.equals(operation) || EnvironmentMappingActions.CLOSE_OP.equals(operation)){
          // Check that mapping identifier is present.
          validateEntityObjectId();
       }
       else if (EnvironmentMappingActions.FORM_OP.equals(operation)){
          // Check and see if logical env key is missing.
          if (logicalEnvKey == null || logicalEnvKey.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.envmapping.logicalenv"));
       }
       else if (EnvironmentMappingActions.CREATE_OP.equals(operation)){
          // Check and see if logical env key is missing.
          if (logicalEnvKey == null || logicalEnvKey.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.envmapping.logicalenv"));
          // Check and see if physical env key is missing.
          if (physicalEnvKey == null || physicalEnvKey.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.envmapping.physicalenv"));
       }
       else if (EnvironmentMappingActions.VIEW_OP.equals(operation)){
          // Check and see if no environment key is specified.
          if ((logicalEnvKey == null || logicalEnvKey.length() == 0)
                  && (physicalEnvKey == null || physicalEnvKey.length() == 0)){
             // Add 2 action errors cause there's no "OR" error message yet...
             addActionError("errors.required", getGuiMessageResources().getMessage("label.envmapping.logicalenv"));
             addActionError("errors.required", getGuiMessageResources().getMessage("label.envmapping.physicalenv"));
          }
       }
    }
 
 
    // Override of ActionForm ---------------------------------------------------
 
    /**
     * Reset form attributes.
     * @param mapping Mapping between forwards name and path for this action
     * @param request The servlet container request wrapper
     */
    public void reset(ActionMapping mapping, HttpServletRequest request){
       super.reset(mapping, request);
       logicalEnvKey = null;
       physicalEnvKey = null;
       startDate = null;
       endDate = null;
    }
 }