/**
    * 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.DeploymentActions;
  
  import org.apache.struts.action.ActionMapping;
  
  import javax.servlet.http.HttpServletRequest;
  
  import java.util.Date;
  import java.util.Calendar;
  import java.text.SimpleDateFormat;
  /**
   * Form object used for manipulating Deployments into Join application.
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.2 $
   *
   * @struts.form name="deploymentForm"
   */
  public class DeploymentForm extends JoinForm{
  
     // Attributes ---------------------------------------------------------------
  
     /** Identifier of user who asked for deployment */
     private String applicantId;
     /** Comments on deployment demand made by applicants */
     private String applicantComments;
     /** Identifier of user assigned to deployment relaization */
     private String assigneeId;
     /** Comments on deployment relalization made by assignee */
     private String assigneeComments;
     /** The deployment demand creation date */
     private Date creationDate;
     /** The deployment demand assignation date */
     private Date assignationDate;
     /** The deployment realization date */
     private Date realizationDate;
     /** The date applicant wished the deployment's done */
     private Date wishedDate;
  
     /** The key of assembly to deploy */
     private String assemblyKey;
     /** The key of logical environment to deploy on */
     private String logicalEnvKey;
     /** The identifier of deployment target */
     private String targetName;
     /** The key of deployment status */
     private String statusKey;
  
     /** String representation of <code>creationDate</code> */
     private String creationDateStr;
     /** String represantation of <code>assignationDate</code> */
     private String assignationDateStr;
     /** String representation of <code>realizationDate</code> */
     private String realizationDateStr;
     /** String representation of <code>wishedDate</code> */
     private String wishedDateStr;
     /** String representation of <code>wishedHour</code> */
     private String wishedHourStr = "12";
     /** String representation of <code>wishedMin</code> */
     private String wishedMinStr = "00";
  
  
     // Constructors -------------------------------------------------------------
  
     /** Creates a new DeploymentForm instance */
     public DeploymentForm(){
     }
  
  
     // Public -------------------------------------------------------------------
  
     /** @return The identifier of user who asked for deployment */
     public String getApplicantId(){
        return applicantId;
     }
     /** @param applicantId The identifier of user who asked for deployment */
     public void setApplicantId(String applicantId){
        this.applicantId = applicantId;
     }
     /** @return The comments made by applicant on deployment demand */
     public String getApplicantComments(){
        return applicantComments;
     }
     /** @param comments The comments made by applicant on deployment demand */
    public void setApplicantComments(String comments){
       this.applicantComments = comments;
    }
    /** @return The identifier of user assigned to deployment realization */
    public String getAssigneeId(){
       return assigneeId;
    }
    /** @param assigneeId The identifier of user assigned to deployment realization */
    public void setAssigneeId(String assigneeId){
       this.assigneeId = assigneeId;
    }
    /** @return The comments on deployment from assignee */
    public String getAssigneeComments(){
       return assigneeComments;
    }
    /** @param comments The comments on deployment from assignee */
    public void setAssigneeComments(String comments){
       this.assigneeComments = comments;
    }
 
    /** @return The creation date of the deployment demand */
    public Date getCreationDate(){
       return creationDate;
    }
    /** @param creationDate The creation date of the deployment demand */
    public void setCreationDate(Date creationDate){
       this.creationDate = creationDate;
       // Format to string according to locale.
       SimpleDateFormat format = new SimpleDateFormat(getMessageResources().getMessage("pattern.date.stringtodate"));
       this.creationDateStr = format.format(creationDate);
    }
    /** @return The deployment demand assignation date */
    public Date getAssignationDate(){
       return assignationDate;
    }
    /** @param assignationDate The date deployment realization is assigned to an integrator */
    public void setAssignationDate(Date assignationDate){
       this.assignationDate = assignationDate;
       // Format to string according to locale.
       SimpleDateFormat format = new SimpleDateFormat(getMessageResources().getMessage("pattern.date.stringtodate"));
       this.assignationDateStr = format.format(assignationDate);
    }
    /** @return The deployment realization date */
    public Date getRealizationDate(){
       return realizationDate;
    }
    /** @param realizationDate The deployment realization timestamp */
    public void setRealizationDate(Date realizationDate){
       this.realizationDate = realizationDate;
       // Format to string according to locale.
       SimpleDateFormat format = new SimpleDateFormat(getMessageResources().getMessage("pattern.date.stringtodate"));
       this.realizationDateStr = format.format(realizationDate);
    }
    /** @return The date applicant wished the deployment's done */
    public Date getWishedDate(){
       return wishedDate;
    }
    /** @param wishedDate The date application wished the deployment's done */
    public void setWishedDate(Date wishedDate){
       this.wishedDate = wishedDate;
       // Format to string according to locale.
       SimpleDateFormat format = new SimpleDateFormat(getMessageResources().getMessage("pattern.date.stringtodate"));
       this.wishedDateStr = format.format(wishedDate);
    }
 
    /** @return The key of assembly to deploy */
    public String getAssemblyKey(){
       return assemblyKey;
    }
    /** @param assemblyKey The key of assembly to deploy */
    public void setAssemblyKey(String assemblyKey){
       this.assemblyKey = assemblyKey;
    }
    /** @return The key of logical environment to deploy on */
    public String getLogicalEnvKey(){
       return logicalEnvKey;
    }
    /** @param logicalEnvKey The key of logical environment to deploy on */
    public void setLogicalEnvKey(String logicalEnvKey){
       this.logicalEnvKey = logicalEnvKey;
    }
    /** @return The identifier of deployment target */
    public String getTargetName(){
       return targetName;
    }
    /** @param targetName The identifier of deployment target */
    public void setTargetName(String targetName){
       this.targetName = targetName;
    }
    /** @return The key of deployment status */
    public String getStatusKey(){
       return statusKey;
    }
    /** @param statusKey The key of deployment status */
    public void setStatusKey(String statusKey){
       this.statusKey = statusKey;
    }
 
    /** @return Date of creation (must be a date) */
    public String getCreationDateStr(){
       return creationDateStr;
    }
    /** @param creationDateStr Date of creation (must be a date) */
    public void setCreationDateStr(String creationDateStr){
       this.creationDateStr = creationDateStr;
    }
    /** @return Date of assignation (must be a date) */
    public String getAssignationDateStr(){
       return assignationDateStr;
    }
    /** @param assignationDateStr Date of assignation (must be a date) */
    public void setAssignationDateStr(String assignationDateStr){
       this.assignationDateStr = assignationDateStr;
    }
    /** @return realizationDateStr Date of realisation (must be a date) */
    public String getRealizationDateStr(){
       return realizationDateStr;
    }
    /** @param realizationDateStr Date of realisation (must be a date) */
    public void setRealizationDateStr(String realizationDateStr){
       this.realizationDateStr = realizationDateStr;
    }
    /** @return Date of wished deployment (must be a date) */
    public String getWishedDateStr(){
       return wishedDateStr;
    }
    /** @param wishedDateStr Date of wished deployment (must be a date) */
    public void setWishedDateStr(String wishedDateStr){
       this.wishedDateStr = wishedDateStr;
    }
 
    /** @return String representation of wished hour */
    public String getWishedHourStr(){
       return wishedHourStr;
    }
    /** @param wishedHourStr String representation of wished hour */
    public void setWishedHourStr(String wishedHourStr){
       this.wishedHourStr = wishedHourStr;
    }
    /** @return String representation of wished minutes */
    public String getWishedMinStr(){
       return wishedMinStr;
    }
    /** @param wishedMinStr String representation of wished minutes */
    public void setWishedMinStr(String wishedMinStr){
       this.wishedMinStr = wishedMinStr;
    }
 
 
    // Implementation of JoinForm -----------------------------------------------
 
    /**
     * Validate 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){
 
       if (DeploymentActions.LOAD_OP.equals(operation) || DeploymentActions.PREPARE_OP.equals(operation)
             || DeploymentActions.REALIZE_OP.equals(operation) || DeploymentActions.END_OP.equals(operation)
                || DeploymentActions.CANCEL_OP.equals(operation) || DeploymentActions.STATUS_OP.equals(operation)){
          // Check if deployment id is missing.
          validateEntityObjectId();
       }
       else if (DeploymentActions.CREATE_OP.equals(operation)){
          // Check if assembly key is missing.
          if (assemblyKey == null || assemblyKey.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.deployment.assembly"));
          // Check if logical environment key is missing.
          if (logicalEnvKey == null || logicalEnvKey.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.deployment.environment"));
          // Check if deployment target name is missing.
          if (targetName == null || targetName.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.deployment.target"));
          // Check if applicant comments are missing.
          if (applicantComments == null || applicantComments.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.deployment.applicantcomments"));
          // Check if wished date is missing.
          if (wishedDateStr == null || wishedDateStr.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.deployment.wisheddate"));
          else{
             // Check if it's parsable.
             SimpleDateFormat format = new SimpleDateFormat(getMessageResources().getMessage("pattern.date.stringtodate"));
             try {wishedDate = format.parse(wishedDateStr);}
             catch (Exception e){
                addActionError("errors.format", getGuiMessageResources().getMessage("label.deployment.wisheddate"));
             }
 
             if (wishedDate != null){
                Calendar wishedCal = Calendar.getInstance();
                wishedCal.setTime(wishedDate);
                // Check if hour is missing.
                if (wishedHourStr == null || wishedHourStr.length() == 0)
                   addActionError("errors.required", getGuiMessageResources().getMessage("label.deployment.wihedhour"));
                else{
                   // Check if it's parsable.
                   try {wishedCal.set(Calendar.HOUR_OF_DAY, Integer.parseInt(wishedHourStr));}
                   catch (Exception e){
                      addActionError("errors.range",
                              getGuiMessageResources().getMessage("label.deployment.wisheddate.hour", "0", "23"));
                   }
                }
                // Check if minute is missing.
                if (wishedMinStr == null || wishedMinStr.length() == 0)
                   addActionError("errors.required", getGuiMessageResources().getMessage("label.deployment.wishedmin"));
                else{
                   // Check if it's parsable.
                   try {wishedCal.set(Calendar.MINUTE, Integer.parseInt(wishedMinStr));}
                   catch (Exception e){
                      addActionError("errors.range",
                              getGuiMessageResources().getMessage("label.deployment.wisheddate.minute", "0", "59"));
                   }
                }
             }
          }
       }
    }
 
 
    // 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);
       this.applicantId = null;
       this.applicantComments = null;
       this.assigneeId = null;
       this.assigneeComments = null;
       this.wishedDate = null;
       this.assemblyKey = null;
       this.logicalEnvKey = null;
       this.targetName = null;
       this.statusKey = null;
       this.wishedDateStr = null;
       this.wishedHourStr = "12";
       this.wishedMinStr = "00";
    }
 }