CreateApplicationForm.java

/**
 * Copyright (C) 2008-2010, Squale Project - http://www.squale.org
 *
 * This file is part of Squale.
 *
 * Squale is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 *
 * Squale 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.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Squale.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.squale.squaleweb.applicationlayer.formbean.creation;

import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import org.apache.struts.action.ActionError;
import org.apache.struts.action.ActionMapping;

import org.squale.squalecommon.datatransfertobject.component.AuditDTO;
import org.squale.squalecommon.enterpriselayer.businessobject.component.AuditBO;
import org.squale.squaleweb.applicationlayer.formbean.RootForm;
import org.squale.squaleweb.applicationlayer.formbean.access.AccessListForm;
import org.squale.squaleweb.applicationlayer.formbean.component.AuditForm;
import org.squale.squaleweb.applicationlayer.formbean.config.ServeurForm;

/**
 * Form bean for a Struts application.
 * 
 * @version 1.0
 * @author
 */
public class CreateApplicationForm
    extends RootForm
{

    /** Les acc�s utilisateur */
    private AccessListForm mAccessListForm;

    /**
     * Pr�cise le site auquel appartient l'application
     */
    private ServeurForm mServeurForm = new ServeurForm();

    /**
     * Pr�cise si les audits sont r�alis�s uniquement sur demande
     */
    private boolean mMilestone = false;

    /**
     * L'audit de jalon si l'application en a un programm�
     */
    private AuditForm mMilestoneAudit = new AuditForm();

    /**
     * D�lai de purge par d�faut
     */
    public static final int DEFAULT_PURGE_DELAY = 180;

    /**
     * D�lai de purge par d�faut
     */
    public static final int DEFAULT_AUDIT_FREQUENCY = 15;

    /**
     * D�lai entre deux purges de l'application
     */
    private int mPurgeDelay = DEFAULT_PURGE_DELAY;

    /**
     * D�lai entre deux purges de l'application
     */
    private int mAuditFrequency = DEFAULT_AUDIT_FREQUENCY;

    /**
     * Status de l'application
     */
    private int mStatus;

    /**
     * Liste des projets de l'application
     */
    private List mProjects = new ArrayList();

    /**
     * Liste des droits sur l'application
     */
    private Map mRights = new HashMap();

    /**
     * Caract�re publique
     */
    private boolean mPublic;

    /** indique si l'application �tait d�ja en production au moment de sa cr�ation dans SQUALE */
    private boolean isInProduction = false;

    /** indique si l'application a �t� d�velopp� en externe */
    private boolean externalDev = false;

    /** Date de la derni�re modification */
    private Date mLastUpdate;

    /** L'utilisateur ayant fait la derni�re modification */
    private String mLastUser;

    /**
     * Does the quality approach started at the beginning of the project
     */
    private boolean mIsQualityApproachOnStart;

    /**
     * Does the application is in its initial development phase
     */
    private boolean mIsInInitialDev;

    /**
     * Does the application is in its initial development phase
     */
    private int globalCostMaintenance;

    /**
     * Global cost of the application
     */
    private int globalCostInitial;

    /**
     * The development cost of the application in its initial development phase. Only available when the project is on
     * its initial development phase.
     */
    private int devCost;

    /**
     * @return le bool�en indiquant si le dev a �t� fait en externe ou pas
     */
    public boolean getExternalDev()
    {
        return externalDev;
    }

    /**
     * @return le bool�en indiquant si l'application �tait d�j� en production au moment de sa cr�ation dans squale
     */
    public boolean getIsInProduction()
    {
        return isInProduction;
    }

    /**
     * @param pExternal le bool�en indiquant si le dev a �t� fait en externe
     */
    public void setExternalDev( boolean pExternal )
    {
        externalDev = pExternal;
    }

    /**
     * @param pInProduction le bool�en indiquant si l'application �tait d�j� en production au moment de sa cr�ation dans
     *            squale
     */
    public void setIsInProduction( boolean pInProduction )
    {
        isInProduction = pInProduction;
    }

    /**
     * @return le d�lai de purge
     */
    public int getPurgeDelay()
    {
        return mPurgeDelay;
    }

    /**
     * @param pPurgeDelay le d�lai de purge (en jour)
     */
    public void setPurgeDelay( int pPurgeDelay )
    {
        mPurgeDelay = pPurgeDelay;
    }

    /**
     * @return la fr�quence d'audit en jours
     */
    public int getAuditFrequency()
    {
        return mAuditFrequency;
    }

    /**
     * @param pAuditFrequency la fr�quence d'audit en jours
     */
    public void setAuditFrequency( int pAuditFrequency )
    {
        mAuditFrequency = pAuditFrequency;
    }

    /**
     * @return la valeur de mMilestone.
     */
    public boolean isMilestone()
    {
        return mMilestone;
    }

    /**
     * @param pMilestone la nouvelle valeur de mMilestone.
     */
    public void setMilestone( boolean pMilestone )
    {
        mMilestone = pMilestone;
    }

    /**
     * @return la liste des projets de l'application
     */
    public List getProjects()
    {
        return mProjects;
    }

    /**
     * @param pProjects la liste des projets de l'application
     */
    public void setProjects( List pProjects )
    {
        mProjects = pProjects;
    }

    /**
     * @return la map des droits utilisateur / droits
     */
    public Map getRights()
    {
        return mRights;
    }

    /**
     * @param pMap la map des droits utilisateur / droits
     */
    public void setRights( Map pMap )
    {
        mRights = pMap;
    }

    /**
     * @param pStatus status
     */
    public void setStatus( int pStatus )
    {
        mStatus = pStatus;
    }

    /**
     * @return status
     */
    public int getStatus()
    {
        return mStatus;
    }

    /**
     * Initialisation des champs Cette m�thode permet de r�initialiser les champs autrement que par la m�thode reset
     * classique car le formbean est utilis� en session et sous la forme d'un wizard
     */
    public void resetFields()
    {
        setApplicationId( "-1" );
        setApplicationName( null );
        mMilestone = false;
        mPurgeDelay = DEFAULT_PURGE_DELAY;
        mAuditFrequency = DEFAULT_AUDIT_FREQUENCY;
        mStatus = 0;
        mProjects = new ArrayList();
        mRights = new HashMap();
        mMilestoneAudit = new AuditForm();
        mMilestoneAudit.setType( AuditBO.MILESTONE );
        mServeurForm = null;
    }

    /**
     * @param pPublic caract�re publique
     */
    public void setPublic( boolean pPublic )
    {
        mPublic = pPublic;
    }

    /**
     * @return caract�re publique
     */
    public boolean isPublic()
    {
        return mPublic;
    }

    /**
     * @see org.apache.struts.action.ActionForm#reset(org.apache.struts.action.ActionMapping,
     *      javax.servlet.http.HttpServletRequest) {@inheritDoc}
     */
    public void reset( ActionMapping arg0, HttpServletRequest arg1 )
    {
        super.reset( arg0, arg1 );
        setMilestone( false );
        setPublic( false );
        setExternalDev( false );
        setIsInProduction( false );
        setInInitialDev( false );
        setQualityApproachOnStart( false );
    }

    /**
     * @return l'audit de jalon programm�
     */
    public AuditForm getMilestoneAudit()
    {
        return mMilestoneAudit;
    }

    /**
     * @param pAuditForm l'audit de jalon programm�
     */
    public void setMilestoneAudit( AuditForm pAuditForm )
    {
        mMilestoneAudit = pAuditForm;
    }

    /**
     * Remet � z�ro l'audit de jalon.
     */
    public void resetMilestoneAudit()
    {
        mMilestoneAudit = new AuditForm();

    }

    /**
     * @param pAuditDTO l'audit sous forme dto
     */
    public void setMilestoneAudit( AuditDTO pAuditDTO )
    {
        AuditForm audit = new AuditForm( pAuditDTO );
        setMilestoneAudit( audit );
    }

    /**
     * @return la date de la derni�re modification
     */
    public Date getLastUpdate()
    {
        return mLastUpdate;
    }

    /**
     * @param pDate la date de la derni�re modification
     */
    public void setLastUpdate( Date pDate )
    {
        mLastUpdate = pDate;
    }

    /**
     * @return l'utilisateur ayant fait la derni�re modification
     */
    public String getLastUser()
    {
        return mLastUser;
    }

    /**
     * @param pMatricule l'utilisateur ayant fait la derni�re modification
     */
    public void setLastUser( String pMatricule )
    {
        mLastUser = pMatricule;
    }

    /**
     * M�thode de validation pour v�rifier que le nom mis � l'application ne contient pas de caract�res sp�ciaux. La
     * liste des caract�res sp�ciaux est d�fini par le pattern situ� dans la classe m�re
     * 
     * @param pMapping le mapping hibernate
     * @param pRequest la requete
     */
    public void wValidate( ActionMapping pMapping, HttpServletRequest pRequest )
    {
        if ( getApplicationName().trim().length() == 0 )
        {
            addError( "applicationName", new ActionError( "error.application.name.empty" ) );
        }
        else if ( !isAValidName( getApplicationName() ) )
        {
            addError( "applicationName", new ActionError( "error.name.containsInvalidCharacter" ) );
        }
    }

    /**
     * <p>
     * Inspired from the wValidate method. < /br> Needed to validate renamming of an application
     * </p>
     * 
     * @param pMapping the ActionMapping Object
     * @param pRequest pRequest the request send by the application
     * @return An ActionError if the name is not valid (empty String or not compliant with the naming pattern) or null
     *         if the name is valid
     */
    public ActionError validateName( ActionMapping pMapping, HttpServletRequest pRequest )
    {
        ActionError returnedError = null;
        if ( getApplicationName().trim().length() == 0 )
        {
            returnedError = new ActionError( "error.application.name.empty" );
        }
        else if ( !isAValidName( getApplicationName() ) )
        {
            returnedError = new ActionError( "error.name.containsInvalidCharacter" );
        }
        return returnedError;
    }

    /**
     * @return le formulaire du Serveur
     */
    public ServeurForm getServeurForm()
    {
        return mServeurForm;
    }

    /**
     * @param pServeurForm le formulaire du Serveur
     */
    public void setServeurForm( ServeurForm pServeurForm )
    {
        mServeurForm = pServeurForm;
    }

    /**
     * @param pForm les acc�s
     */
    public void setAccessListForm( AccessListForm pForm )
    {
        mAccessListForm = pForm;
    }

    /**
     * @return les acc�s utilisateur
     */
    public AccessListForm getAccessListForm()
    {
        return mAccessListForm;
    }

    /**
     * Getter method for the attribute isQualityApproachOnStart
     * 
     * @return true if the quality approach started at the beginning of the project
     */
    public boolean getQualityApproachOnStart()
    {
        return ( mIsQualityApproachOnStart );
    }

    /**
     * Setter method for the attribute isQualityApproachOnStart
     * 
     * @param pIsQualityApproachOnStart The new value for the attribute isQualityApproachOnStart
     */
    public void setQualityApproachOnStart( boolean pIsQualityApproachOnStart )
    {
        mIsQualityApproachOnStart = pIsQualityApproachOnStart;
    }

    /**
     * Getter method for the attribute isInInitialDev
     * 
     * @return true if the application is in initial development phase
     */
    public boolean getInInitialDev()
    {
        return mIsInInitialDev;
    }

    /**
     * Setter method for the attribute isInInitialDev
     * 
     * @param pIsInInitialDev The new value for the attribute isInInitialDev
     */
    public void setInInitialDev( boolean pIsInInitialDev )
    {
        mIsInInitialDev = pIsInInitialDev;
    }

    /**
     * Getter method for the attribute globalCostMaintenance
     * 
     * @return The global cost of the application in maintenance
     */
    public int getGlobalCostMaintenance()
    {
        return globalCostMaintenance;
    }

    /**
     * Setter method for the attribute globalCostMaintenance
     * 
     * @param pGlobalCostMaintenance The new value for globalcost attribute
     */
    public void setGlobalCostMaintenance( int pGlobalCostMaintenance )
    {
        globalCostMaintenance = pGlobalCostMaintenance;
    }

    /**
     * Getter method for the attribute globalCostInitial
     * 
     * @return The global cost of the application in initial dev
     */
    public int getGlobalCostInitial()
    {
        return globalCostInitial;
    }

    /**
     * Setter method for the attribute globalCostInitial
     * 
     * @param pGlobalCostInitial The new value for globalCostInitial attribute
     */
    public void setGlobalCostInitial( int pGlobalCostInitial )
    {
        globalCostInitial = pGlobalCostInitial;
    }

    /**
     * Getter method for the attribute devCost
     * 
     * @return the development cost of the application
     */
    public int getDevCost()
    {
        return devCost;
    }

    /**
     * Setter method for the devCost attribute
     * 
     * @param pDevCost The new value for the devcost attribute
     */
    public void setDevCost( int pDevCost )
    {
        devCost = pDevCost;
    }

}