// license-header java merge-point
//
// Attention: Generated code! Do not modify by hand!
// Generated by: hibernate/HibernateEntity.vsl in andromda-hibernate-cartridge.
//
package fr.ifremer.adagio.core.dao.referential.pmfm;

/*
 * #%L
 * SIH-Adagio :: Core
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2012 - 2014 Ifremer
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * 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.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * #L%
 */

import fr.ifremer.adagio.core.dao.referential.Status;
import fr.ifremer.adagio.core.dao.referential.ValidityStatus;
import java.io.Serializable;

/**
 * Liste des valeurs qualitatives que peut prendre un paramètre.
 * Par exemple :
 * - pour le paramètre Sexe : "Mâle" et "Femelle"
 * - pour le paramètre Présentation : "Vidé", "Entier", ...
 * - pour le paramètre Catégorie : "Gros", "Moyen", ...
 */
// HibernateEntity.vsl annotations merge-point
public abstract class QualitativeValue
    implements Serializable, Comparable<QualitativeValue>
{
    /**
     * The serial version UID of this class. Needed for serialization.
     */
    private static final long serialVersionUID = 7138352793414117324L;

    // Generate 5 attributes
    private Integer id;

    /**
     * Idenfiant interne. Généré par le système.
     * @return this.id Integer
     */
    public Integer getId()
    {
        return this.id;
    }

    /**
     * Idenfiant interne. Généré par le système.
     * @param idIn Integer
     */
    public void setId(Integer idIn)
    {
        this.id = idIn;
    }

    private String label;

    /**
     * 
     * @return this.label String
     */
    public String getLabel()
    {
        return this.label;
    }

    /**
     * 
     * @param labelIn String
     */
    public void setLabel(String labelIn)
    {
        this.label = labelIn;
    }

    private String name;

    /**
     * 
     * @return this.name String
     */
    public String getName()
    {
        return this.name;
    }

    /**
     * 
     * @param nameIn String
     */
    public void setName(String nameIn)
    {
        this.name = nameIn;
    }

    private String description;

    /**
     * 
     * @return this.description String
     */
    public String getDescription()
    {
        return this.description;
    }

    /**
     * 
     * @param descriptionIn String
     */
    public void setDescription(String descriptionIn)
    {
        this.description = descriptionIn;
    }

    private String comments;

    /**
     * 
     * @return this.comments String
     */
    public String getComments()
    {
        return this.comments;
    }

    /**
     * 
     * @param commentsIn String
     */
    public void setComments(String commentsIn)
    {
        this.comments = commentsIn;
    }

    // Generate 25 associations
    private ValidityStatus validityStatus;

    /**
     * Etat de validation d'une donnée du référentiel. Utile pour les responsables de référentiel.
     * Validity status of a referential data.
     * @return this.validityStatus ValidityStatus
     */
    public ValidityStatus getValidityStatus()
    {
        return this.validityStatus;
    }

    /**
     * Etat de validation d'une donnée du référentiel. Utile pour les responsables de référentiel.
     * Validity status of a referential data.
     * @param validityStatusIn ValidityStatus
     */
    public void setValidityStatus(ValidityStatus validityStatusIn)
    {
        this.validityStatus = validityStatusIn;
    }

    private Status status;

    /**
     * Pour les données du référentiel, information permettant de déterminer si une donnée est
     * valide,
     * obsolète ou temporaire.
     * - obsolète (=inactif) : '0'
     * - valide (=actif) : '1'
     * - temporaire : '2'
     * - en cours de suppression : '3'
     * -  : '4'
     * note : on a préfère ici 'valide' au terme 'actif' (utilisé dans Harmonie), pour ne pas
     * confondre
     * avec par exemple l'activité d'un navire sur un mois.
     * @return this.status Status
     */
    public Status getStatus()
    {
        return this.status;
    }

    /**
     * Pour les données du référentiel, information permettant de déterminer si une donnée est
     * valide,
     * obsolète ou temporaire.
     * - obsolète (=inactif) : '0'
     * - valide (=actif) : '1'
     * - temporaire : '2'
     * - en cours de suppression : '3'
     * -  : '4'
     * note : on a préfère ici 'valide' au terme 'actif' (utilisé dans Harmonie), pour ne pas
     * confondre
     * avec par exemple l'activité d'un navire sur un mois.
     * @param statusIn Status
     */
    public void setStatus(Status statusIn)
    {
        this.status = statusIn;
    }

    private Parameter parameter;

    /**
     * Un paramètre est une propriété du milieu ou d'un élément du milieu qui contribue à en
     * apprécier les
     * caractéristiques et/ou la qualité et/ou l'aptitude à des usages.
     * Le paramètre se décline en trois types : quantitatif, qualitatif ou libre.
     * Le type quantitatif se rapporte aux paramètres qui ont une infinité de résultats numériques.
     * Le type qualitatif se rapporte aux paramètres qui ne prennent qu'un nombre limité de valeurs
     * prédéfinies pour chacun d'eux.
     * Le type libre, ou alphanumérique, correspond aux paramètres de valeurs alphanumériques, sans
     * limite
     * de valeurs possibles (hormis la longueur de la chaine : 40 max).
     * Ces trois types sont mutuellement exclusifs.
     * Exemple de paramètre :
     * • Taille (numérique)
     * • Age (numérique)
     * • Sexe (qualitatif)
     * • Catégorie commerciale (qualitatif)
     * • Présentation commerciale (qualitatif)
     * • Vrac / Hors Vrac (qualitatif)
     * • Rejet / Débarquement (qualitatif) (Discard/Landing)
     * • Stade de maturité (qualitatif) (Maturity stage)
     * • Numéro de contrat (libre - alphanumérique)
     * Cette liste n’est pas exhaustive.
     * Nombre de lignes : 130
     * @return this.parameter Parameter
     */
    public Parameter getParameter()
    {
        return this.parameter;
    }

    /**
     * Un paramètre est une propriété du milieu ou d'un élément du milieu qui contribue à en
     * apprécier les
     * caractéristiques et/ou la qualité et/ou l'aptitude à des usages.
     * Le paramètre se décline en trois types : quantitatif, qualitatif ou libre.
     * Le type quantitatif se rapporte aux paramètres qui ont une infinité de résultats numériques.
     * Le type qualitatif se rapporte aux paramètres qui ne prennent qu'un nombre limité de valeurs
     * prédéfinies pour chacun d'eux.
     * Le type libre, ou alphanumérique, correspond aux paramètres de valeurs alphanumériques, sans
     * limite
     * de valeurs possibles (hormis la longueur de la chaine : 40 max).
     * Ces trois types sont mutuellement exclusifs.
     * Exemple de paramètre :
     * • Taille (numérique)
     * • Age (numérique)
     * • Sexe (qualitatif)
     * • Catégorie commerciale (qualitatif)
     * • Présentation commerciale (qualitatif)
     * • Vrac / Hors Vrac (qualitatif)
     * • Rejet / Débarquement (qualitatif) (Discard/Landing)
     * • Stade de maturité (qualitatif) (Maturity stage)
     * • Numéro de contrat (libre - alphanumérique)
     * Cette liste n’est pas exhaustive.
     * Nombre de lignes : 130
     * @param parameterIn Parameter
     */
    public void setParameter(Parameter parameterIn)
    {
        this.parameter = parameterIn;
    }

    /**
     * Returns <code>true</code> if the argument is an QualitativeValue instance and all identifiers for this entity
     * equal the identifiers of the argument entity. Returns <code>false</code> otherwise.
     */
    @Override
    public boolean equals(Object object)
    {
        if (this == object)
        {
            return true;
        }
        if (!(object instanceof QualitativeValue))
        {
            return false;
        }
        final QualitativeValue that = (QualitativeValue)object;
        if (this.id == null || that.getId() == null || !this.id.equals(that.getId()))
        {
            return false;
        }
        return true;
    }

    /**
     * Returns a hash code based on this entity's identifiers.
     */
    @Override
    public int hashCode()
    {
        int hashCode = 0;
        hashCode = 29 * hashCode + (this.id == null ? 0 : this.id.hashCode());

        return hashCode;
    }

    /**
     * Constructs new instances of {@link QualitativeValue}.
     */
    public static final class Factory
    {
        /**
         * Constructs a new instance of {@link QualitativeValue}.
         * @return new QualitativeValueImpl()
         */
        public static QualitativeValue newInstance()
        {
            return new QualitativeValueImpl();
        }

        /**
         * Constructs a new instance of {@link QualitativeValue}, taking all required and/or
         * read-only properties as arguments, except for identifiers.
         * @param name String
         * @param validityStatus ValidityStatus
         * @param status Status
         * @param parameter Parameter
         * @return newInstance
         */
        public static QualitativeValue newInstance(String name, ValidityStatus validityStatus, Status status, Parameter parameter)
        {
            final QualitativeValue entity = new QualitativeValueImpl();
            entity.setName(name);
            entity.setValidityStatus(validityStatus);
            entity.setStatus(status);
            entity.setParameter(parameter);
            return entity;
        }

        /**
         * Constructs a new instance of {@link QualitativeValue}, taking all possible properties
         * (except the identifier(s))as arguments.
         * @param label String
         * @param name String
         * @param description String
         * @param comments String
         * @param validityStatus ValidityStatus
         * @param status Status
         * @param parameter Parameter
         * @return newInstance QualitativeValue
         */
        public static QualitativeValue newInstance(String label, String name, String description, String comments, ValidityStatus validityStatus, Status status, Parameter parameter)
        {
            final QualitativeValue entity = new QualitativeValueImpl();
            entity.setLabel(label);
            entity.setName(name);
            entity.setDescription(description);
            entity.setComments(comments);
            entity.setValidityStatus(validityStatus);
            entity.setStatus(status);
            entity.setParameter(parameter);
            return entity;
        }
    }

    /**
     * @see Comparable#compareTo
     */
    public int compareTo(QualitativeValue o)
    {
        int cmp = 0;
        if (this.getId() != null)
        {
            cmp = this.getId().compareTo(o.getId());
        }
        else
        {
            if (this.getLabel() != null)
            {
                cmp = (cmp != 0 ? cmp : this.getLabel().compareTo(o.getLabel()));
            }
            if (this.getName() != null)
            {
                cmp = (cmp != 0 ? cmp : this.getName().compareTo(o.getName()));
            }
            if (this.getDescription() != null)
            {
                cmp = (cmp != 0 ? cmp : this.getDescription().compareTo(o.getDescription()));
            }
            if (this.getComments() != null)
            {
                cmp = (cmp != 0 ? cmp : this.getComments().compareTo(o.getComments()));
            }
        }
        return cmp;
    }
// HibernateEntity.vsl merge-point
// QualitativeValue.java merge-point
}