/**
    * 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.StatusActions;
  
  import org.apache.struts.action.ActionMapping;
  
  import javax.servlet.http.HttpServletRequest;
  /**
   * Form object used for manipulating Steps into Join application.
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.1 $
   *
   * @struts.form name="statusForm"
   */
  public class StatusForm extends JoinForm{
  
     // Attributes ---------------------------------------------------------------
     
     /** The unique key of this status */
     private String key;
     /** The display label of this status */
     private String label;
     /** The type of process this status is for */
     private String type;
     /** Whether this status is terminal in process */
     private boolean terminal;
     /** Whether this status corresponds to a 'cancel' status in process */
     private boolean cancelled;
     
     /** String representation of <b>terminal</b> */
     private String terminalStr;
     /** String representation of <b>cancelled</b> */
     private String cancelledStr;
     
     
     // Constructors -------------------------------------------------------------
     
     /** Creates a new instance of StatusForm. */
     public StatusForm(){
     }
     
     
     // Public -------------------------------------------------------------------
     
     /** @return The unique key of this status */
     public String getKey(){
        return key;
     }
     /** @param key The unique key of this status */
     public void setKey(String key){
        this.key = key;
     }
     /** @return The display label of this status */
     public String getLabel(){
        return label;
     }
     /** @param label The label of this status */
     public void setLabel(String label){
        this.label = label;
     }
     /** @return The type of process this status is for */
     public String getType(){
        return type;
     }
     /** @param type The type of process this status is for */
     public void setType(String type){
        this.type = type;
     }
     /** @return Flag telling if status is terminal for a process */
     public boolean isTerminal(){
        return terminal;
     }
     /** @param terminal Flag telling if status is terminal for a process */
     public void setTerminal(boolean terminal){
        this.terminal = terminal;
        this.terminalStr = String.valueOf(terminal);
     }
     /** @return Flag telling if status corresponds to a 'cancel' */
     public boolean isCancelled(){
        return cancelled;  
     }
     /** @param cancelled Flag telling if status corresponds to a 'cancel' */
     public void setCancelled(boolean cancelled){
        this.cancelled = cancelled;
       this.cancelledStr = String.valueOf(cancelled);
    }
    
    /** @return Flag telling if status is terminal for a process (should be a boolean) */
    public String getTerminalStr(){
       return terminalStr;
    }
    /** @param terminalStr Flag telling if status is terminal for a process (should be a boolean) */
    public void setTerminalStr(String terminalStr){
       this.terminalStr = terminalStr;
    }
    /** @return Flag telling if status corresponds to a 'cancel' (should be a boolean) */
    public String getCancelledStr(){
       return cancelledStr;  
    }
    /** @param cancelledStr Flag telling if status corresponds to a 'cancel' */
    public void setCancelledStr(String cancelledStr){
       this.cancelledStr = cancelledStr;
    }
    
    
    // Implementation 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){
       
       if (StatusActions.LOAD_OP.equals(operation)){
          // Check and see if id is missing.
          validateEntityObjectId();
       }
       else if (StatusActions.SAVE_OP.equals(operation)){
          // Check and see if key is missing.
          if (key == null || key.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.status.key"));
          // Check and see if label is missing.
          if (label == null || label.length() == 0)
             addActionError("errors.required", getGuiMessageResources().getMessage("label.status.label"));
          
          // Get boolean values for flags.
          terminal = Boolean.valueOf(terminalStr).booleanValue();
          cancelled = Boolean.valueOf(cancelledStr).booleanValue();
          // Check consistency.
          if (terminal && cancelled)
             addActionError("errors.invalid", getGuiMessageResources().getMessage("label.status.cancelled"));
       }
    }
    
    
    // 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;
       type = null;
       terminal = false;
       cancelled = false;
       terminalStr = null;
       cancelledStr = null;
    }
 }