/**
    * 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.LogicalEnvironmentActions;
  import org.apache.struts.action.ActionMapping;
  
  import javax.servlet.http.HttpServletRequest;
  /**
   * This is a Struts form for managing and manipulating LogicalEnvironment into Join.
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.1 $
   *
   * @struts.form name="logicalEnvForm"
   */
  public class LogicalEnvironmentForm extends JoinForm{
  
     // Attributes ---------------------------------------------------------------
  
     /** The key of current logical environment. */
     private String key;
     /** The label of current logical environment. */
     private String label;
     /** The description of current logical environment. */
     private String description;
     /** The identifier of logical environment manager. */
     private String managerId;
     /** The flag telling if logical environment is active or not; */
     private boolean active = true;
     /** The name of release this environment is attached to */
     private String releaseName;
     /** The unique id of step this environment is dedicated to */
     private long stepId = -1;
  
     /** String representation of the <b>active</b> flag. */
     private String activeStr;
     /** String representation of the <b>stepId</b> long. */
     private String stepIdStr;
  
  
     // Constructors -------------------------------------------------------------
  
     /** Creates a new LogicalEnvironmentForm. */
     public LogicalEnvironmentForm(){
     }
  
  
     // Public -------------------------------------------------------------------
  
     /** @return The business key of current logical environment */
     public String getKey(){
        return key;
     }
     /** @param key The business key of current logical environment */
     public void setKey(String key){
        this.key = key;
     }
     /** @return The label of current logical environment */
     public String getLabel(){
        return label;
     }
     /** @param label The label of logical environment represented by form */
     public void setLabel(String label){
        this.label = label;
     }
     /** @return The description of the currently loaded logical environment */
     public String getDescription(){
        return description;
     }
     /** @param description The description of the current logical environment */
     public void setDescription(String description){
        this.description = description;
     }
     /** @return The identifier of user managing the logical environment */
     public String getManagerId(){
        return managerId;
     }
     /** @param managerId The identifier of manager for logical environment */
     public void setManagerId(String managerId){
        this.managerId = managerId;
     }
     /** @return true if the logical environment is active. */
     public boolean isActive(){
        return active;
     }
     /** @param active The flag telling if environment is active */
    public void setActive(boolean active){
       this.active = active;
       this.activeStr = String.valueOf(active);
    }
    /** @return The name of the release this environment is attached to */
    public String getReleaseName(){
       return releaseName;
    }
    /** @param releaseName The name of release this environment is attached to */
    public void setReleaseName(String releaseName){
       this.releaseName = releaseName;
    }
    /** @return The unique id of step this environment is dedicated to */
    public long getStepId(){
       return stepId;
    }
    /** @param stepId The unique id of step this environment is dedicated to */
    public void setStepId(long stepId){
       this.stepId = stepId;
       this.stepIdStr = String.valueOf(stepId);
    }
 
    /** @return Flag telling if current environment is active or not */
    public String getActiveStr(){
       return activeStr;
    }
    /** @param activeStr Flag telling if current environment is active or not */
    public void setActiveStr(String activeStr){
       this.activeStr = activeStr;
    }
    /** @return String representation of the <b>stepId</b> long */
    public String getStepIdStr(){
       return stepIdStr;
    }
    /** @param stepIdStr String representation of the <b>stepId</b> long. */
    public void setStepIdStr(String stepIdStr){
       this.stepIdStr = stepIdStr;
    }
 
 
    // Implementation of JoinForm -----------------------------------------------
 
    /**
     * Validate form attributes depending on 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 (LogicalEnvironmentActions.LOAD_OP.equals(operation)){
          // Check and see if key is missing.
          if (key == null || key.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.logicalenv.key"));
       }
       else if (LogicalEnvironmentActions.SAVE_OP.equals(operation)){
          // Check and see if key is missing.
          if (key == null || key.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.logicalenv.key"));
          // Check and see if label is missing.
          if (label == null || label.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.logicalenv.label"));
          // Check and see if description is missing.
          if (description == null || description.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.logicalenv.description"));
          // Check and see if managerId is missing.
          if (managerId == null || managerId.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.logicalenv.managerId"));
          // Check and see if release is missing.
          if (releaseName == null || releaseName.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.logicalenv.release"));
          // Check and see if step is missing.
          if (stepIdStr == null || stepIdStr.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.logicalenv.step"));
          else{
             // Check and see if step is a long.
             try {stepId = Long.valueOf(stepIdStr).longValue();}
             catch (Exception e){
                addActionError("errors.integer", getGuiMessageResources().getMessage("label.logicalenv.step"));
             }
          }
 
          // Parse the active flag.
          active = Boolean.valueOf(activeStr).booleanValue();
       }
    }
 
 
    // 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);
       key = null;
       label = null;
       description = null;
       managerId = null;
       stepId = -1;
       releaseName = null;
       activeStr = null;
    }
 }