PracticeRuleDTO.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.squalecommon.datatransfertobject.rule;

/**
 * DTO d'une pratique qualit�
 */
public class PracticeRuleDTO
    extends QualityRuleDTO
{

    /** Indication d'une pratique de type violation de r�gle */
    private boolean mRuleChecking;

    /** Formule */
    private AbstractFormulaDTO mFormula;

    /** La fonction de pond�ration */
    private String mWeightingFunction;

    /** parfois on a seulement besoin du type de la formule (graph de r�partition) */
    private String mFormulaType;

    /** l'effort � fournie pour la correction */
    private int mEffort;

    /** Period of validity for a mark */
    private String timeLimitation;

    /**
     * @return formule
     */
    public AbstractFormulaDTO getFormula()
    {
        return mFormula;
    }

    /**
     * @param pFormulaDTO formule
     */
    public void setFormula( AbstractFormulaDTO pFormulaDTO )
    {
        mFormula = pFormulaDTO;
    }

    /**
     * @return indicateur de rulechecking
     */
    public boolean isRuleChecking()
    {
        return mRuleChecking;
    }

    /**
     * @param pRuleChecking indicateur de r�gle
     */
    public void setRuleChecking( boolean pRuleChecking )
    {
        mRuleChecking = pRuleChecking;
    }

    /**
     * @return la fonction de pond�ration
     */
    public String getWeightingFunction()
    {
        return mWeightingFunction;
    }

    /**
     * @param pWeightingFormula la fonction de pond�ration
     */
    public void setWeightingFunction( String pWeightingFormula )
    {
        mWeightingFunction = pWeightingFormula;
    }

    /**
     * @return le type de la formule
     */
    public String getFormulaType()
    {
        return mFormulaType;
    }

    /**
     * @param pFormulaType le type de la formule
     */
    public void setFormulaType( String pFormulaType )
    {
        mFormulaType = pFormulaType;
    }

    /**
     * @return l'effort de correction
     */
    public int getEffort()
    {
        return mEffort;
    }

    /**
     * @param pEffort l'effort de correction
     */
    public void setEffort( int pEffort )
    {
        mEffort = pEffort;
    }

    /**
     * Getter methods for the timeLimitation attribute. This attribute is compose of 2 parts : The last character of the
     * String represent the unit of the period : 'D' for DAY, 'M' for MONTH, 'Y' for YEAR, 'A' like always for marks
     * which have no time limitation (In this case this 'A' is the only element of the String). The beginning of the
     * String is a number which represent the period of validity.
     * 
     * @return The timeLimitation value
     */
    public String getTimeLimitation()
    {
        return timeLimitation;
    }

    /**
     * Setter method for the attribute timeLimitation. This attribute is compose of 2 parts : The last character of the
     * String represent the unit of the period : 'D' for DAY, 'M' for MONTH, 'Y' for YEAR, 'A' like always for marks
     * which have no time limitation (In this case this 'A' is the only element of the String). The beginning of the
     * String is a number which represent the duration of the validity.
     * 
     * @param mTimeLimitation The new timeLimitation attribute
     */
    public void setTimeLimitation( String mTimeLimitation )
    {
        timeLimitation = mTimeLimitation;
    }

    @Override
    public boolean equals( Object obj )
    {
        boolean equal = false;
        if ( obj instanceof PracticeRuleDTO )
        {
            if(getName().equals( ((PracticeRuleDTO)obj).getName()))
            {
                equal=true;
            }
        }
        return equal;
    }

    @Override
    public int hashCode()
    {
        return getName().hashCode();
    }

}