// 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.taxon;

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

/**
 * 
 */
// HibernateEntity.vsl annotations merge-point
public abstract class ReferenceTaxon
    implements Serializable, Comparable<ReferenceTaxon>
{
    /**
     * The serial version UID of this class. Needed for serialization.
     */
    private static final long serialVersionUID = 922202299998876456L;

    // Generate 3 attributes
    private Integer id;

    /**
     * Cet identifiant unique est porté par les libellés valides et non par les synonymes.La
     * modification d'un libellé n'entraîne pas de changement de cet identifiant.C’est le code
     * unique et définitif de l’entité référencée. Le code permanent est le marqueur spécifique de
     * l’entité qui est conservé en cas de changement de dénomination de celle-ci ; il n’est jamais
     * réattribué en cas de disparition de l’entité (le code disparaît avec elle).Le code permanent
     * est non-intelligent, c’est-à-dire qu’il n’intègre aucune autre information que
     * l’identification univoque et non-ambiguë de l’entité.
     * @return this.id Integer
     */
    public Integer getId()
    {
        return this.id;
    }

    /**
     * Cet identifiant unique est porté par les libellés valides et non par les synonymes.La
     * modification d'un libellé n'entraîne pas de changement de cet identifiant.C’est le code
     * unique et définitif de l’entité référencée. Le code permanent est le marqueur spécifique de
     * l’entité qui est conservé en cas de changement de dénomination de celle-ci ; il n’est jamais
     * réattribué en cas de disparition de l’entité (le code disparaît avec elle).Le code permanent
     * est non-intelligent, c’est-à-dire qu’il n’intègre aucune autre information que
     * l’identification univoque et non-ambiguë de l’entité.
     * @param idIn Integer
     */
    public void setId(Integer idIn)
    {
        this.id = idIn;
    }

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

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

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

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

        /**
         * Constructs a new instance of {@link ReferenceTaxon}, taking all required and/or
         * read-only properties as arguments, except for identifiers.
         * @param updateDate Timestamp
         * @return newInstance
         */
        public static ReferenceTaxon newInstance(Timestamp updateDate)
        {
            final ReferenceTaxon entity = new ReferenceTaxonImpl();
            entity.setUpdateDate(updateDate);
            return entity;
        }

        /**
         * Constructs a new instance of {@link ReferenceTaxon}, taking all possible properties
         * (except the identifier(s))as arguments.
         * @param updateDate Timestamp
         * @param name String
         * @return newInstance ReferenceTaxon
         */
        public static ReferenceTaxon newInstance(Timestamp updateDate, String name)
        {
            final ReferenceTaxon entity = new ReferenceTaxonImpl();
            entity.setUpdateDate(updateDate);
            entity.setName(name);
            return entity;
        }
    }

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