// 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 java.io.Serializable;
import java.sql.Timestamp;

/**
 * Niveau (ou période) d'agrégation de la donnée.
 * Par exemple :
 * - aucune (pas d'agrégation)
 * - jour,
 * - mois,
 * - année
 * - marée
 * - opération
 * - zone de peche (cas des séquences de peche ?)
 * Utiliser une période d'agrégation permet de définir des valeurs moyennes sur une période
 * d'agrégation (par exemple : le mois) indépendamment de la période concernée (par exemple : une
 * année).
 * Exemple :
 * - moyenne mensuelle sur l'année, du nombre d'engin levé par jour :
 * - paramètre : nombre d'engin levé
 * - niveau d'agrégation du PSFM : jour
 * - période concerné : 01/01/XX au 31/12/XX : définie au niveau de l'entité à laquelle est
 * rattachée la mesure (exemple : la marée, l'opération, les caractéristiques d'utilisation, etc.).
 * - période d'agrégation sur la mesure (xxxMeasurement) : mois
 */
// HibernateEntity.vsl annotations merge-point
public abstract class AggregationLevel
    implements Serializable, Comparable<AggregationLevel>
{
    /**
     * The serial version UID of this class. Needed for serialization.
     */
    private static final long serialVersionUID = -4681955582651361615L;

    // 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 name;

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

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

    private Integer rankOrder;

    /**
     * rang permettant de classer les niveau d'agrégation par ordre de précision : le niveau le plus
     * bas est 'aucune' (donnée brute), le niveau le plus haut pourrait etre 'année' (moyenne
     * annuelle)
     * @return this.rankOrder Integer
     */
    public Integer getRankOrder()
    {
        return this.rankOrder;
    }

    /**
     * rang permettant de classer les niveau d'agrégation par ordre de précision : le niveau le plus
     * bas est 'aucune' (donnée brute), le niveau le plus haut pourrait etre 'année' (moyenne
     * annuelle)
     * @param rankOrderIn Integer
     */
    public void setRankOrder(Integer rankOrderIn)
    {
        this.rankOrder = rankOrderIn;
    }

    private Timestamp updateDate;

    /**
     * 
     * @return this.updateDate Timestamp
     */
    public Timestamp getUpdateDate()
    {
        return this.updateDate;
    }

    /**
     * 
     * @param updateDateIn Timestamp
     */
    public void setUpdateDate(Timestamp updateDateIn)
    {
        this.updateDate = updateDateIn;
    }

    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 3 associations
    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;
    }

    /**
     * Returns <code>true</code> if the argument is an AggregationLevel 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 AggregationLevel))
        {
            return false;
        }
        final AggregationLevel that = (AggregationLevel)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 AggregationLevel}.
     */
    public static final class Factory
    {
        /**
         * Constructs a new instance of {@link AggregationLevel}.
         * @return new AggregationLevelImpl()
         */
        public static AggregationLevel newInstance()
        {
            return new AggregationLevelImpl();
        }

        /**
         * Constructs a new instance of {@link AggregationLevel}, taking all required and/or
         * read-only properties as arguments, except for identifiers.
         * @param name String
         * @param rankOrder Integer
         * @param updateDate Timestamp
         * @param status Status
         * @return newInstance
         */
        public static AggregationLevel newInstance(String name, Integer rankOrder, Timestamp updateDate, Status status)
        {
            final AggregationLevel entity = new AggregationLevelImpl();
            entity.setName(name);
            entity.setRankOrder(rankOrder);
            entity.setUpdateDate(updateDate);
            entity.setStatus(status);
            return entity;
        }

        /**
         * Constructs a new instance of {@link AggregationLevel}, taking all possible properties
         * (except the identifier(s))as arguments.
         * @param name String
         * @param rankOrder Integer
         * @param updateDate Timestamp
         * @param comments String
         * @param status Status
         * @return newInstance AggregationLevel
         */
        public static AggregationLevel newInstance(String name, Integer rankOrder, Timestamp updateDate, String comments, Status status)
        {
            final AggregationLevel entity = new AggregationLevelImpl();
            entity.setName(name);
            entity.setRankOrder(rankOrder);
            entity.setUpdateDate(updateDate);
            entity.setComments(comments);
            entity.setStatus(status);
            return entity;
        }
    }

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