AbstractParameterForm.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.component.parameters;

import javax.servlet.http.HttpServletRequest;

import org.apache.struts.action.ActionMapping;

import org.squale.squaleweb.applicationlayer.formbean.RootForm;

/**
 * Classe abstraite pour les param�tres d'un projet
 */
public abstract class AbstractParameterForm
    extends RootForm
{
    /** Indicate if it's the first time this task is setting */
    protected boolean newConf = true;

    /**
     * @return le transformer du bean
     */
    public abstract Class getTransformer();

    /**
     * @return les constantes des param�tres
     */
    public abstract String[] getParametersConstants();

    /**
     * @return si le bean n'est pas valid�
     */
    public boolean isValid()
    {
        return ( null == getErrors() ) || getErrors().isEmpty();
    }

    /**
     * @return le nom du bean en session
     */
    public abstract String getNameInSession();

    /**
     * @return le nom de la t�che associ�e
     */
    public abstract String getTaskName();

    /**
     * @see org.squale.welcom.struts.bean.WActionForm#wValidate(org.apache.struts.action.ActionMapping,
     *      javax.servlet.http.HttpServletRequest) {@inheritDoc}
     */
    public void wValidate( ActionMapping arg0, HttpServletRequest arg1 )
    {
        // On ajoute le nom de la t�che � la requ�te pour indiquer au dropPanel
        // qu'il faut qu'il soit ouvert
        arg1.setAttribute( "tool", getTaskName() );
        // On ne valide pas les formulaires si on d�configure la t�che
        String action = (String) arg1.getParameter( "action" );
        // on teste donc sur l'action r�alis�e
        if ( null == action || !( "removeParameters" ).equals( action ) )
        {
            validateConf( arg0, arg1 );
        }
    }

    /**
     * Valide le formulaire
     * 
     * @param pMapping le mapping
     * @param pRequest la requ�te
     */
    protected abstract void validateConf( ActionMapping pMapping, HttpServletRequest pRequest );

    /**
     * @return true if it's the first time this task is setting
     */
    public boolean isNewConf()
    {
        return newConf;
    }

    /**
     * @param pNewConf indicate if it's the first time this task is setting
     */
    public void setNewConf( boolean pNewConf )
    {
        newConf = pNewConf;
    }

}