// 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.administration.programStrategy;

/*
 * #%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.Collection;
import java.util.HashSet;

/**
 * Une stratégie applicable est la stratégie qui s'applique pour un lieu de surveillance donné
 * durant un interval de dates défini.
 */
// HibernateEntity.vsl annotations merge-point
public abstract class AppliedStrategy
    implements Serializable, Comparable<AppliedStrategy>
{
    /**
     * The serial version UID of this class. Needed for serialization.
     */
    private static final long serialVersionUID = 5822927428345985698L;

    // Generate 1 attributes
    private Integer id;

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

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

    // Generate 5 associations
    private Collection<BatchModelAppliedStrategy> batchModelAppliedStrategies = new HashSet<BatchModelAppliedStrategy>();

    /**
     * 
     * @return this.batchModelAppliedStrategies Collection<BatchModelAppliedStrategy>
     */
    public Collection<BatchModelAppliedStrategy> getBatchModelAppliedStrategies()
    {
        return this.batchModelAppliedStrategies;
    }

    /**
     * 
     * @param batchModelAppliedStrategiesIn Collection<BatchModelAppliedStrategy>
     */
    public void setBatchModelAppliedStrategies(Collection<BatchModelAppliedStrategy> batchModelAppliedStrategiesIn)
    {
        this.batchModelAppliedStrategies = batchModelAppliedStrategiesIn;
    }

    /**
     * 
     * @param elementToAdd BatchModelAppliedStrategy
     * @return <tt>true</tt> if this collection changed as a result of the
     *         call
     */
    public boolean addBatchModelAppliedStrategies(BatchModelAppliedStrategy elementToAdd)
    {
        return this.batchModelAppliedStrategies.add(elementToAdd);
    }

    /**
     * 
     * @param elementToRemove BatchModelAppliedStrategy
     * @return <tt>true</tt> if this collection changed as a result of the
     *         call
     */
    public boolean removeBatchModelAppliedStrategies(BatchModelAppliedStrategy elementToRemove)
    {
        return this.batchModelAppliedStrategies.remove(elementToRemove);
    }

    private Collection<AppliedPeriod> appliedPeriods = new HashSet<AppliedPeriod>();

    /**
     * Interval de dates d'une stratégie applicable.
     * @return this.appliedPeriods Collection<AppliedPeriod>
     */
    public Collection<AppliedPeriod> getAppliedPeriods()
    {
        return this.appliedPeriods;
    }

    /**
     * Interval de dates d'une stratégie applicable.
     * @param appliedPeriodsIn Collection<AppliedPeriod>
     */
    public void setAppliedPeriods(Collection<AppliedPeriod> appliedPeriodsIn)
    {
        this.appliedPeriods = appliedPeriodsIn;
    }

    /**
     * Interval de dates d'une stratégie applicable.
     * @param elementToAdd AppliedPeriod
     * @return <tt>true</tt> if this collection changed as a result of the
     *         call
     */
    public boolean addAppliedPeriods(AppliedPeriod elementToAdd)
    {
        return this.appliedPeriods.add(elementToAdd);
    }

    /**
     * Interval de dates d'une stratégie applicable.
     * @param elementToRemove AppliedPeriod
     * @return <tt>true</tt> if this collection changed as a result of the
     *         call
     */
    public boolean removeAppliedPeriods(AppliedPeriod elementToRemove)
    {
        return this.appliedPeriods.remove(elementToRemove);
    }

    private Strategy strategy;

    /**
     * La stratégie définit a priori ce que devront être les données présentes dans le système de
     * l'origine
     * de la collecte des données. Il s'agit de la liste des paramètres à mesurer, ainsi que des
     * méthodes
     * préconisées pour chacun de ces paramètres. La stratégie permet ainsi d'aider à la saisie des
     * données, en personnalisant les écrans, et facilite la consultation rapide du contenu
     * théorique de la
     * base.
     * Par exemple, on pourra avoir les stratégies suivantes :
     * - stratégie "échantillonnage pendant les marées observées"
     * - stratégie "échantillonnage pendant les campagne à la mer"
     * @return this.strategy Strategy
     */
    public Strategy getStrategy()
    {
        return this.strategy;
    }

    /**
     * La stratégie définit a priori ce que devront être les données présentes dans le système de
     * l'origine
     * de la collecte des données. Il s'agit de la liste des paramètres à mesurer, ainsi que des
     * méthodes
     * préconisées pour chacun de ces paramètres. La stratégie permet ainsi d'aider à la saisie des
     * données, en personnalisant les écrans, et facilite la consultation rapide du contenu
     * théorique de la
     * base.
     * Par exemple, on pourra avoir les stratégies suivantes :
     * - stratégie "échantillonnage pendant les marées observées"
     * - stratégie "échantillonnage pendant les campagne à la mer"
     * @param strategyIn Strategy
     */
    public void setStrategy(Strategy strategyIn)
    {
        this.strategy = strategyIn;
    }

    private Location location;

    /**
     * Représente un lieu au sens général du terme. Il peut s'agir d'un lieu ponctuel, linéaire ou
     * surfacique.
     * Suivant sa classification et son niveau, il peut s'agir d'un secteur FAO, un port de pêche,
     * un
     * quartier maritime, une criée, etc.
     * Nombre de lignes : lieux terrestre : 4500 + secteurs : 11210 + strates : 1000 + localités :
     * 200
     * @return this.location Location
     */
    public Location getLocation()
    {
        return this.location;
    }

    /**
     * Représente un lieu au sens général du terme. Il peut s'agir d'un lieu ponctuel, linéaire ou
     * surfacique.
     * Suivant sa classification et son niveau, il peut s'agir d'un secteur FAO, un port de pêche,
     * un
     * quartier maritime, une criée, etc.
     * Nombre de lignes : lieux terrestre : 4500 + secteurs : 11210 + strates : 1000 + localités :
     * 200
     * @param locationIn Location
     */
    public void setLocation(Location locationIn)
    {
        this.location = locationIn;
    }

    private Collection<PmfmAppliedStrategy> pmfmAppliedStrategies = new HashSet<PmfmAppliedStrategy>();

    /**
     * 
     * @return this.pmfmAppliedStrategies Collection<PmfmAppliedStrategy>
     */
    public Collection<PmfmAppliedStrategy> getPmfmAppliedStrategies()
    {
        return this.pmfmAppliedStrategies;
    }

    /**
     * 
     * @param pmfmAppliedStrategiesIn Collection<PmfmAppliedStrategy>
     */
    public void setPmfmAppliedStrategies(Collection<PmfmAppliedStrategy> pmfmAppliedStrategiesIn)
    {
        this.pmfmAppliedStrategies = pmfmAppliedStrategiesIn;
    }

    /**
     * 
     * @param elementToAdd PmfmAppliedStrategy
     * @return <tt>true</tt> if this collection changed as a result of the
     *         call
     */
    public boolean addPmfmAppliedStrategies(PmfmAppliedStrategy elementToAdd)
    {
        return this.pmfmAppliedStrategies.add(elementToAdd);
    }

    /**
     * 
     * @param elementToRemove PmfmAppliedStrategy
     * @return <tt>true</tt> if this collection changed as a result of the
     *         call
     */
    public boolean removePmfmAppliedStrategies(PmfmAppliedStrategy elementToRemove)
    {
        return this.pmfmAppliedStrategies.remove(elementToRemove);
    }

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

        /**
         * Constructs a new instance of {@link AppliedStrategy}, taking all required and/or
         * read-only properties as arguments, except for identifiers.
         * @param appliedPeriods Collection<AppliedPeriod>
         * @param strategy Strategy
         * @param location Location
         * @return newInstance
         */
        public static AppliedStrategy newInstance(Collection<AppliedPeriod> appliedPeriods, Strategy strategy, Location location)
        {
            final AppliedStrategy entity = new AppliedStrategyImpl();
            entity.setAppliedPeriods(appliedPeriods);
            entity.setStrategy(strategy);
            entity.setLocation(location);
            return entity;
        }

        /**
         * Constructs a new instance of {@link AppliedStrategy}, taking all possible properties
         * (except the identifier(s))as arguments.
         * @param batchModelAppliedStrategies Collection<BatchModelAppliedStrategy>
         * @param appliedPeriods Collection<AppliedPeriod>
         * @param strategy Strategy
         * @param location Location
         * @param pmfmAppliedStrategies Collection<PmfmAppliedStrategy>
         * @return newInstance AppliedStrategy
         */
        public static AppliedStrategy newInstance(Collection<BatchModelAppliedStrategy> batchModelAppliedStrategies, Collection<AppliedPeriod> appliedPeriods, Strategy strategy, Location location, Collection<PmfmAppliedStrategy> pmfmAppliedStrategies)
        {
            final AppliedStrategy entity = new AppliedStrategyImpl();
            entity.setBatchModelAppliedStrategies(batchModelAppliedStrategies);
            entity.setAppliedPeriods(appliedPeriods);
            entity.setStrategy(strategy);
            entity.setLocation(location);
            entity.setPmfmAppliedStrategies(pmfmAppliedStrategies);
            return entity;
        }
    }

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