/**
    * 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.businessobjects.commons;
  
  import org.figure8.join.core.EntityObject;
  /**
   * This is an entity representing a process status.
   * <br/>
   * Some process are well identified within Join workflow such as that returned
   * by the MANAGED_TYPES constant from this class. Defining status for these process
   * allow you to better monitor them.
   * <br/>
   * Some status should also be marked as "terminal" in order to help Join detecting
   * process end and thus workflow transition. An exemple is the end of the assembly
   * creation process : when assembly has reached a terminal status, Join may propose
   * users to deploy this assembly onto an environnment ; thus starting a new deployment
   * preparation process, and so on...
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.2 $
   *
   * @hibernate.class table="join_status" lazy="true"
   * @hibernate.cache usage="read-write"
   *
   * @hibernate.query name="join.status_findByKey" query="from Status st where st.key = :key"
   * @hibernate.query name="join.status_findByType" query="from Status st where st.type = :type"
   */
  public class Status extends EntityObject{
  
     // Static -------------------------------------------------------------------
     
     /** Constant for the status type corresponding to build process. */
     public static final String BUILD_TYPE = "build";
     /** Constant for the status type corresponding to assembly process. */
     public static final String ASSEMBLY_TYPE = "assembly";
     /** Constant for the status type corresponding to deployment preparation process. */
     public static final String DEPLOYMENT_PREPARATION_TYPE = "deployment preparation";
     /** Constant for the status type corresponding to deployment realisation process. */
     public static final String DEPLOYMENT_REALIZATION_TYPE = "deployment realization";
     
     /** Constant for the list of managed status types (one type by process). */
     public static final String[] MANAGED_TYPES = new String[]{BUILD_TYPE, ASSEMBLY_TYPE,
        DEPLOYMENT_PREPARATION_TYPE, DEPLOYMENT_REALIZATION_TYPE};
     
     
     // 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 = false;
     /** Whether this status corresponds to a 'cancel' status in process */
     private boolean cancelled = false;
     
     
     // Constructors -------------------------------------------------------------
     
     /** Creates a new insatnce of Status. */
     public Status(){
     }
     
     /**
      * Creates a new instance of Status with mandatory attributes.
      * @param key The unique key for status
      * @param label The display label for status
      * @param type The type of process this status is for
      */
     public Status(String key, String label, String type){
        this.key = key;
        this.label = label;
        this.type = type;
     }
     
     
     // Public -------------------------------------------------------------------
     
     /**
      * @hibernate.property column="s_key"
      *    not-null="true" unique="true"
      *    length="20"
      * @return This status unique key
      */
     public String getKey(){
        return key;
    }
    /** @param key This status unique key */
    public void setKey(String key){
       this.key = key;
    }
    
    /**
     * @hibernate.property column="s_label"
     *    not-null="true" length="40"
     * @return The display label for status
     */
    public String getLabel(){
       return label;
    }
    /** @param label This status label for display */
    public void setLabel(String label){
       this.label = label;
    }
    
    /**
     * @hibernate.property column="s_type" length="30"
     * @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;  
    }
    
    /**
     * @hibernate.property column="b_terminal" type="boolean"
     * @return Whether this status is terminal in process
     */
    public boolean isTerminal(){
       return terminal;
    }
    /** @param terminal Whether this status is terminal in process */
    public void setTerminal(boolean terminal){
       this.terminal = terminal;
    }
    
    /**
     * @hibernate.property column="b_cancelled" type="boolean"
     * @return Whether status is a cancelled one
     */
    public boolean isCancelled(){
       return cancelled;
    }
    /** @param cancelled Whether this status is a cancel step in process */
    public void setCancelled(boolean cancelled){
       this.cancelled = cancelled;
    }
 }