// 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.data.vessel;

/*
 * #%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.location.Location;
import java.io.Serializable;
import java.util.Date;

/**
 * Période d'armement, ou de mise en service, du navire.
 * La mise en service est rattaché à un lieu terrestre de mise en service. Cela peut etre le pays
 * d'armement ou le quartier d'armement.
 */
// HibernateEntity.vsl annotations merge-point
public abstract class VesselCommissioningPeriod
    implements Serializable, Comparable<VesselCommissioningPeriod>
{
    /**
     * The serial version UID of this class. Needed for serialization.
     */
    private static final long serialVersionUID = 4526710880810578705L;

    private VesselCommissioningPeriodPK vesselCommissioningPeriodPk;

    /**
     * Get the composite primary key identifier class
     * @return vesselCommissioningPeriodPk
     */
    public VesselCommissioningPeriodPK getVesselCommissioningPeriodPk()
    {
        return this.vesselCommissioningPeriodPk;
    }

    /**
     * Set the composite primary key identifier class
     * @param vesselCommissioningPeriodPkIn
     */
    public void setVesselCommissioningPeriodPk(VesselCommissioningPeriodPK vesselCommissioningPeriodPkIn) {
        this.vesselCommissioningPeriodPk = vesselCommissioningPeriodPkIn;
    }

    // Generate 2 attributes
    /**
     * 
     * @return this.startDate Date
     */
    public Date getStartDate()
    {
        return this.getVesselCommissioningPeriodPk().getStartDate();
    }

    /**
     * 
     * @param startDateIn Date
     */
    public void setStartDate(Date startDateIn)
    {
        this.getVesselCommissioningPeriodPk().setStartDate(startDateIn);
    }

    private Date endDate;

    /**
     * 
     * @return this.endDate Date
     */
    public Date getEndDate()
    {
        return this.endDate;
    }

    /**
     * 
     * @param endDateIn Date
     */
    public void setEndDate(Date endDateIn)
    {
        this.endDate = endDateIn;
    }

    // Generate 2 associations
    private Location commissioningLocation;

    /**
     * Lieu de mise en service. Cela peut etre un pays, ou le quartier d'armement.
     * @return this.commissioningLocation Location
     */
    public Location getCommissioningLocation()
    {
        return this.commissioningLocation;
    }

    /**
     * Lieu de mise en service. Cela peut etre un pays, ou le quartier d'armement.
     * @param commissioningLocationIn Location
     */
    public void setCommissioningLocation(Location commissioningLocationIn)
    {
        this.commissioningLocation = commissioningLocationIn;
    }

    private Vessel vessel;

    /**
     * Navire, ou plus généralement un usager de la ressource.
     * Peut etre un navire de peche professionnel ou non, un navire scientifique, un pêcheur à pied,
     * un
     * groupement de navires, etc.
     * @return this.vessel Vessel
     */
    public Vessel getVessel()
    {
        return this.vessel;
    }

    /**
     * Navire, ou plus généralement un usager de la ressource.
     * Peut etre un navire de peche professionnel ou non, un navire scientifique, un pêcheur à pied,
     * un
     * groupement de navires, etc.
     * @param vesselIn Vessel
     */
    public void setVessel(Vessel vesselIn)
    {
        this.vessel = vesselIn;
    }

    /**
     * Returns <code>true</code> if the argument is an VesselCommissioningPeriod 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 VesselCommissioningPeriod))
        {
            return false;
        }
        final VesselCommissioningPeriod that = (VesselCommissioningPeriod)object;
        if (this.vesselCommissioningPeriodPk == null || that.vesselCommissioningPeriodPk == null || !this.vesselCommissioningPeriodPk.equals(that.vesselCommissioningPeriodPk))
        {
            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.vesselCommissioningPeriodPk == null ? 0 : this.vesselCommissioningPeriodPk.hashCode());

        return hashCode;
    }

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

        /**
         * Constructs a new instance of {@link VesselCommissioningPeriod}, taking all required and/or
         * read-only properties as arguments, except for identifiers.
         * @param commissioningLocation Location
         * @param vessel Vessel
         * @return newInstance
         */
        public static VesselCommissioningPeriod newInstance(Location commissioningLocation, Vessel vessel)
        {
            final VesselCommissioningPeriod entity = new VesselCommissioningPeriodImpl();
            entity.setCommissioningLocation(commissioningLocation);
            entity.setVessel(vessel);
            return entity;
        }

        /**
         * Constructs a new instance of {@link VesselCommissioningPeriod}, taking all possible properties
         * (except the identifier(s))as arguments.
         * @param endDate Date
         * @param commissioningLocation Location
         * @param vessel Vessel
         * @return newInstance VesselCommissioningPeriod
         */
        public static VesselCommissioningPeriod newInstance(Date endDate, Location commissioningLocation, Vessel vessel)
        {
            final VesselCommissioningPeriod entity = new VesselCommissioningPeriodImpl();
            entity.setEndDate(endDate);
            entity.setCommissioningLocation(commissioningLocation);
            entity.setVessel(vessel);
            return entity;
        }
    }

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