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

/*
 * #%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;

/**
 * Table de liaison entre une zone de peche effective, et une zone avec une réglementation
 * particulière (ex : ZEE, zone d'effort, etc.).
 * Cela permet de lister, pour une zone de peche effective, dans quelles réglementaires se trouve le
 * navire.
 * Utilisé dans SACAPT.
 * Dans le cas particulier des campagnes scientifique, cette table permet d'associé au rectangle ou
 * sous-rectangle de la zone de pêche, une localité, une strate, ou les deux, suivant ce qui a été
 * défini dans le protocole de collecte.
 */
// HibernateEntity.vsl annotations merge-point
public abstract class FishingArea2RegulationLocation
    implements Serializable, Comparable<FishingArea2RegulationLocation>
{
    /**
     * The serial version UID of this class. Needed for serialization.
     */
    private static final long serialVersionUID = -1355821668296372110L;

    private FishingArea2RegulationLocationPK fishingArea2RegulationLocationPk;

    /**
     * Get the composite primary key identifier class
     * @return fishingArea2RegulationLocationPk
     */
    public FishingArea2RegulationLocationPK getFishingArea2RegulationLocationPk()
    {
        return this.fishingArea2RegulationLocationPk;
    }

    /**
     * Set the composite primary key identifier class
     * @param fishingArea2RegulationLocationPkIn
     */
    public void setFishingArea2RegulationLocationPk(FishingArea2RegulationLocationPK fishingArea2RegulationLocationPkIn) {
        this.fishingArea2RegulationLocationPk = fishingArea2RegulationLocationPkIn;
    }

    // Generate 0 attributes
    // Generate 2 associations
    private FishingArea fishingArea;

    /**
     * Une zone de peche effective
     * @return this.fishingArea FishingArea
     */
    public FishingArea getFishingArea()
    {
        return this.fishingArea;
    }

    /**
     * Une zone de peche effective
     * @param fishingAreaIn FishingArea
     */
    public void setFishingArea(FishingArea fishingAreaIn)
    {
        this.fishingArea = fishingAreaIn;
    }

    private Location location;

    /**
     * Zone réglementaire particulière (ex : ZEE, zone d'effort, etc.)
     * @return this.location Location
     */
    public Location getLocation()
    {
        return this.location;
    }

    /**
     * Zone réglementaire particulière (ex : ZEE, zone d'effort, etc.)
     * @param locationIn Location
     */
    public void setLocation(Location locationIn)
    {
        this.location = locationIn;
    }

    /**
     * This entity does not have any identifiers
     * and is not extending any other entity,
     * so this method will only return <code>true</code> if the argument reference and <code>this</code>
     * refer to the same object.
     */
    @Override
    public boolean equals(Object object)
    {
        return super.equals(object);
    }

    /**
     * This entity does not have any identifiers
     * and is not extending any other entity,
     * so this method will only take the identifiers of this entity into account when calculating the hash code.
     */
    @Override
    public int hashCode()
    {
        return super.hashCode();
    }

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


        /**
         * Constructs a new instance of {@link FishingArea2RegulationLocation}, taking all possible properties
         * (except the identifier(s))as arguments.
         * @param fishingArea FishingArea
         * @param location Location
         * @return newInstance FishingArea2RegulationLocation
         */
        public static FishingArea2RegulationLocation newInstance(FishingArea fishingArea, Location location)
        {
            final FishingArea2RegulationLocation entity = new FishingArea2RegulationLocationImpl();
            entity.setFishingArea(fishingArea);
            entity.setLocation(location);
            return entity;
        }
    }

    /**
     * @see Comparable#compareTo
     */
    public int compareTo(FishingArea2RegulationLocation o)
    {
        int cmp = 0;
        if (this.getFishingArea2RegulationLocationPk() != null)
        {
            cmp = this.getFishingArea2RegulationLocationPk().compareTo(o.getFishingArea2RegulationLocationPk());
        }
        return cmp;
    }
// HibernateEntity.vsl merge-point
// FishingArea2RegulationLocation.java merge-point
}