// 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.quadrige3.core.dao.data.survey;
   
   /*-
    * #%L
   * Quadrige3 Core :: Client API
   * %%
   * Copyright (C) 2017 - 2024 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.quadrige3.core.dao.administration.program.Moratorium;
  import fr.ifremer.quadrige3.core.dao.administration.program.Program;
  import fr.ifremer.quadrige3.core.dao.administration.user.Department;
  import fr.ifremer.quadrige3.core.dao.administration.user.Quser;
  import fr.ifremer.quadrige3.core.dao.referential.monitoringLocation.PositionningSystem;
  import fr.ifremer.quadrige3.core.dao.system.CampaignArea;
  import fr.ifremer.quadrige3.core.dao.system.CampaignLine;
  import fr.ifremer.quadrige3.core.dao.system.CampaignPoint;
  import java.io.Serializable;
  import java.sql.Timestamp;
  import java.util.Collection;
  import java.util.Date;
  import java.util.HashSet;
  
  /**
   * Liste des campagnes.
   */
  // HibernateEntity.vsl annotations merge-point
  public abstract class Campaign
      implements Serializable, Comparable<Campaign>
  {
      /**
       * The serial version UID of this class. Needed for serialization.
       */
      private static final long serialVersionUID = -7823753622861992792L;
  
      // Generate 9 attributes
      private Integer campaignId;
  
      /**
       * Identifiant interne de la campagne. Renseigné par le système dans tous les cas.
       * @return this.campaignId Integer
       */
      public Integer getCampaignId()
      {
          return this.campaignId;
      }
  
      /**
       * Identifiant interne de la campagne. Renseigné par le système dans tous les cas.
       * @param campaignIdIn Integer
       */
      public void setCampaignId(Integer campaignIdIn)
      {
          this.campaignId = campaignIdIn;
      }
  
      private String campaignSismerLk;
  
      /**
       * Lien vers le serveur SISMER. Probablement la référence SISMER de la campagne CAM_CAMREF
       * (FI351997020020 par exemple)
       * @return this.campaignSismerLk String
       */
      public String getCampaignSismerLk()
      {
          return this.campaignSismerLk;
      }
  
      /**
       * Lien vers le serveur SISMER. Probablement la référence SISMER de la campagne CAM_CAMREF
       * (FI351997020020 par exemple)
       * @param campaignSismerLkIn String
       */
      public void setCampaignSismerLk(String campaignSismerLkIn)
      {
          this.campaignSismerLk = campaignSismerLkIn;
      }
  
      private Date campaignStartDt;
  
      /**
      * Date de début de la campagne. ne pas renseigner si SISMER
      * @return this.campaignStartDt Date
      */
     public Date getCampaignStartDt()
     {
         return this.campaignStartDt;
     }
 
     /**
      * Date de début de la campagne. ne pas renseigner si SISMER
      * @param campaignStartDtIn Date
      */
     public void setCampaignStartDt(Date campaignStartDtIn)
     {
         this.campaignStartDt = campaignStartDtIn;
     }
 
     private Date campaignEndDt;
 
     /**
      * Date de fin de la campagne. Ne pas renseigner si SISMER.
      * @return this.campaignEndDt Date
      */
     public Date getCampaignEndDt()
     {
         return this.campaignEndDt;
     }
 
     /**
      * Date de fin de la campagne. Ne pas renseigner si SISMER.
      * @param campaignEndDtIn Date
      */
     public void setCampaignEndDt(Date campaignEndDtIn)
     {
         this.campaignEndDt = campaignEndDtIn;
     }
 
     private String campaignNm;
 
     /**
      * Llibellé décrivant la campagne. Ne pas renseigner si SISMER.
      * @return this.campaignNm String
      */
     public String getCampaignNm()
     {
         return this.campaignNm;
     }
 
     /**
      * Llibellé décrivant la campagne. Ne pas renseigner si SISMER.
      * @param campaignNmIn String
      */
     public void setCampaignNm(String campaignNmIn)
     {
         this.campaignNm = campaignNmIn;
     }
 
     private String campaignCm;
 
     /**
      * Commentaire sur la campagne. Ne pas renseigner si SISMER.
      * @return this.campaignCm String
      */
     public String getCampaignCm()
     {
         return this.campaignCm;
     }
 
     /**
      * Commentaire sur la campagne. Ne pas renseigner si SISMER.
      * @param campaignCmIn String
      */
     public void setCampaignCm(String campaignCmIn)
     {
         this.campaignCm = campaignCmIn;
     }
 
     private String campaignPositionCm;
 
     /**
      * Commentaire associé à la localisation
      * @return this.campaignPositionCm String
      */
     public String getCampaignPositionCm()
     {
         return this.campaignPositionCm;
     }
 
     /**
      * Commentaire associé à la localisation
      * @param campaignPositionCmIn String
      */
     public void setCampaignPositionCm(String campaignPositionCmIn)
     {
         this.campaignPositionCm = campaignPositionCmIn;
     }
 
     private Timestamp updateDt;
 
     /**
      * Date de modification de l'objet, mise à jour par le système
      * @return this.updateDt Timestamp
      */
     public Timestamp getUpdateDt()
     {
         return this.updateDt;
     }
 
     /**
      * Date de modification de l'objet, mise à jour par le système
      * @param updateDtIn Timestamp
      */
     public void setUpdateDt(Timestamp updateDtIn)
     {
         this.updateDt = updateDtIn;
     }
 
     private Integer remoteId;
 
     /**
      * 
      * @return this.remoteId Integer
      */
     public Integer getRemoteId()
     {
         return this.remoteId;
     }
 
     /**
      * 
      * @param remoteIdIn Integer
      */
     public void setRemoteId(Integer remoteIdIn)
     {
         this.remoteId = remoteIdIn;
     }
 
     // Generate 11 associations
     private Collection<Moratorium> moratoria = new HashSet<Moratorium>();
 
     /**
      * Moratoire sur la restriction d'accès aux données
      * @return this.moratoria Collection<Moratorium>
      */
     public Collection<Moratorium> getMoratoria()
     {
         return this.moratoria;
     }
 
     /**
      * Moratoire sur la restriction d'accès aux données
      * @param moratoriaIn Collection<Moratorium>
      */
     public void setMoratoria(Collection<Moratorium> moratoriaIn)
     {
         this.moratoria = moratoriaIn;
     }
 
     /**
      * Moratoire sur la restriction d'accès aux données
      * @param elementToAdd Moratorium
      * @return <tt>true</tt> if this collection changed as a result of the
      *         call
      */
     public boolean addMoratoria(Moratorium elementToAdd)
     {
         return this.moratoria.add(elementToAdd);
     }
 
     /**
      * Moratoire sur la restriction d'accès aux données
      * @param elementToRemove Moratorium
      * @return <tt>true</tt> if this collection changed as a result of the
      *         call
      */
     public boolean removeMoratoria(Moratorium elementToRemove)
     {
         return this.moratoria.remove(elementToRemove);
     }
 
     private Collection<CampaignPoint> campaignPoints = new HashSet<CampaignPoint>();
 
     /**
      * Gestion de la géométrie ponctuelle des campagnes.
      * @return this.campaignPoints Collection<CampaignPoint>
      */
     public Collection<CampaignPoint> getCampaignPoints()
     {
         return this.campaignPoints;
     }
 
     /**
      * Gestion de la géométrie ponctuelle des campagnes.
      * @param campaignPointsIn Collection<CampaignPoint>
      */
     public void setCampaignPoints(Collection<CampaignPoint> campaignPointsIn)
     {
         this.campaignPoints = campaignPointsIn;
     }
 
     /**
      * Gestion de la géométrie ponctuelle des campagnes.
      * @param elementToAdd CampaignPoint
      * @return <tt>true</tt> if this collection changed as a result of the
      *         call
      */
     public boolean addCampaignPoints(CampaignPoint elementToAdd)
     {
         return this.campaignPoints.add(elementToAdd);
     }
 
     /**
      * Gestion de la géométrie ponctuelle des campagnes.
      * @param elementToRemove CampaignPoint
      * @return <tt>true</tt> if this collection changed as a result of the
      *         call
      */
     public boolean removeCampaignPoints(CampaignPoint elementToRemove)
     {
         return this.campaignPoints.remove(elementToRemove);
     }
 
     private Quser quser;
 
     /**
      * Liste l'ensemble des agents et utilisateurs du système.
      * @return this.quser Quser
      */
     public Quser getQuser()
     {
         return this.quser;
     }
 
     /**
      * Liste l'ensemble des agents et utilisateurs du système.
      * @param quserIn Quser
      */
     public void setQuser(Quser quserIn)
     {
         this.quser = quserIn;
     }
 
     private Collection<Program> programs = new HashSet<Program>();
 
     /**
      * Activités à l'origine de la collecte d'un ensemble cohérent de données.
      * @return this.programs Collection<Program>
      */
     public Collection<Program> getPrograms()
     {
         return this.programs;
     }
 
     /**
      * Activités à l'origine de la collecte d'un ensemble cohérent de données.
      * @param programsIn Collection<Program>
      */
     public void setPrograms(Collection<Program> programsIn)
     {
         this.programs = programsIn;
     }
 
     /**
      * Activités à l'origine de la collecte d'un ensemble cohérent de données.
      * @param elementToAdd Program
      * @return <tt>true</tt> if this collection changed as a result of the
      *         call
      */
     public boolean addPrograms(Program elementToAdd)
     {
         return this.programs.add(elementToAdd);
     }
 
     /**
      * Activités à l'origine de la collecte d'un ensemble cohérent de données.
      * @param elementToRemove Program
      * @return <tt>true</tt> if this collection changed as a result of the
      *         call
      */
     public boolean removePrograms(Program elementToRemove)
     {
         return this.programs.remove(elementToRemove);
     }
 
     private Ship ship;
 
     /**
      * Liste des navires intervenant dans les campagnes ou sorties Quadrige2.
      * @return this.ship Ship
      */
     public Ship getShip()
     {
         return this.ship;
     }
 
     /**
      * Liste des navires intervenant dans les campagnes ou sorties Quadrige2.
      * @param shipIn Ship
      */
     public void setShip(Ship shipIn)
     {
         this.ship = shipIn;
     }
 
     private Collection<Occasion> occasions = new HashSet<Occasion>();
 
     /**
      * Liste des sorties effectuées lors d'une campagne.
      * @return this.occasions Collection<Occasion>
      */
     public Collection<Occasion> getOccasions()
     {
         return this.occasions;
     }
 
     /**
      * Liste des sorties effectuées lors d'une campagne.
      * @param occasionsIn Collection<Occasion>
      */
     public void setOccasions(Collection<Occasion> occasionsIn)
     {
         this.occasions = occasionsIn;
     }
 
     /**
      * Liste des sorties effectuées lors d'une campagne.
      * @param elementToAdd Occasion
      * @return <tt>true</tt> if this collection changed as a result of the
      *         call
      */
     public boolean addOccasions(Occasion elementToAdd)
     {
         return this.occasions.add(elementToAdd);
     }
 
     /**
      * Liste des sorties effectuées lors d'une campagne.
      * @param elementToRemove Occasion
      * @return <tt>true</tt> if this collection changed as a result of the
      *         call
      */
     public boolean removeOccasions(Occasion elementToRemove)
     {
         return this.occasions.remove(elementToRemove);
     }
 
     private PositionningSystem positionningSystem;
 
     /**
      * Informations complémentaires sur le positionnement d'un objet.
      * @return this.positionningSystem PositionningSystem
      */
     public PositionningSystem getPositionningSystem()
     {
         return this.positionningSystem;
     }
 
     /**
      * Informations complémentaires sur le positionnement d'un objet.
      * @param positionningSystemIn PositionningSystem
      */
     public void setPositionningSystem(PositionningSystem positionningSystemIn)
     {
         this.positionningSystem = positionningSystemIn;
     }
 
     private Collection<CampaignLine> campaignLines = new HashSet<CampaignLine>();
 
     /**
      * Gestion de la géométrie linéaire des campagnes.
      * @return this.campaignLines Collection<CampaignLine>
      */
     public Collection<CampaignLine> getCampaignLines()
     {
         return this.campaignLines;
     }
 
     /**
      * Gestion de la géométrie linéaire des campagnes.
      * @param campaignLinesIn Collection<CampaignLine>
      */
     public void setCampaignLines(Collection<CampaignLine> campaignLinesIn)
     {
         this.campaignLines = campaignLinesIn;
     }
 
     /**
      * Gestion de la géométrie linéaire des campagnes.
      * @param elementToAdd CampaignLine
      * @return <tt>true</tt> if this collection changed as a result of the
      *         call
      */
     public boolean addCampaignLines(CampaignLine elementToAdd)
     {
         return this.campaignLines.add(elementToAdd);
     }
 
     /**
      * Gestion de la géométrie linéaire des campagnes.
      * @param elementToRemove CampaignLine
      * @return <tt>true</tt> if this collection changed as a result of the
      *         call
      */
     public boolean removeCampaignLines(CampaignLine elementToRemove)
     {
         return this.campaignLines.remove(elementToRemove);
     }
 
     private Department recorderDepartment;
 
     /**
      * Liste les départements ou services auxquels sont rattachés les agents
      * @return this.recorderDepartment Department
      */
     public Department getRecorderDepartment()
     {
         return this.recorderDepartment;
     }
 
     /**
      * Liste les départements ou services auxquels sont rattachés les agents
      * @param recorderDepartmentIn Department
      */
     public void setRecorderDepartment(Department recorderDepartmentIn)
     {
         this.recorderDepartment = recorderDepartmentIn;
     }
 
     private Collection<CampaignArea> campaignAreas = new HashSet<CampaignArea>();
 
     /**
      * Gestion de la géométrie surfacique des campagnes.
      * @return this.campaignAreas Collection<CampaignArea>
      */
     public Collection<CampaignArea> getCampaignAreas()
     {
         return this.campaignAreas;
     }
 
     /**
      * Gestion de la géométrie surfacique des campagnes.
      * @param campaignAreasIn Collection<CampaignArea>
      */
     public void setCampaignAreas(Collection<CampaignArea> campaignAreasIn)
     {
         this.campaignAreas = campaignAreasIn;
     }
 
     /**
      * Gestion de la géométrie surfacique des campagnes.
      * @param elementToAdd CampaignArea
      * @return <tt>true</tt> if this collection changed as a result of the
      *         call
      */
     public boolean addCampaignAreas(CampaignArea elementToAdd)
     {
         return this.campaignAreas.add(elementToAdd);
     }
 
     /**
      * Gestion de la géométrie surfacique des campagnes.
      * @param elementToRemove CampaignArea
      * @return <tt>true</tt> if this collection changed as a result of the
      *         call
      */
     public boolean removeCampaignAreas(CampaignArea elementToRemove)
     {
         return this.campaignAreas.remove(elementToRemove);
     }
 
     /**
      * Returns <code>true</code> if the argument is an Campaign 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 Campaign))
         {
             return false;
         }
         final Campaign that = (Campaign)object;
         if (this.campaignId == null || that.getCampaignId() == null || !this.campaignId.equals(that.getCampaignId()))
         {
             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.campaignId == null ? 0 : this.campaignId.hashCode());
 
         return hashCode;
     }
 
     /**
      * Constructs new instances of {@link Campaign}.
      */
     public static final class Factory
     {
         /**
          * Constructs a new instance of {@link Campaign}.
          * @return new CampaignImpl()
          */
         public static Campaign newInstance()
         {
             return new CampaignImpl();
         }
 
         /**
          * Constructs a new instance of {@link Campaign}, taking all required and/or
          * read-only properties as arguments, except for identifiers.
          * @param campaignStartDt Date
          * @param campaignNm String
          * @param quser Quser
          * @param recorderDepartment Department
          * @return newInstance
          */
         public static Campaign newInstance(Date campaignStartDt, String campaignNm, Quser quser, Department recorderDepartment)
         {
             final Campaign entity = new CampaignImpl();
             entity.setCampaignStartDt(campaignStartDt);
             entity.setCampaignNm(campaignNm);
             entity.setQuser(quser);
             entity.setRecorderDepartment(recorderDepartment);
             return entity;
         }
 
         /**
          * Constructs a new instance of {@link Campaign}, taking all possible properties
          * (except the identifier(s))as arguments.
          * @param campaignSismerLk String
          * @param campaignStartDt Date
          * @param campaignEndDt Date
          * @param campaignNm String
          * @param campaignCm String
          * @param campaignPositionCm String
          * @param updateDt Timestamp
          * @param remoteId Integer
          * @param moratoria Collection<Moratorium>
          * @param campaignPoints Collection<CampaignPoint>
          * @param quser Quser
          * @param programs Collection<Program>
          * @param ship Ship
          * @param occasions Collection<Occasion>
          * @param positionningSystem PositionningSystem
          * @param campaignLines Collection<CampaignLine>
          * @param recorderDepartment Department
          * @param campaignAreas Collection<CampaignArea>
          * @return newInstance Campaign
          */
         public static Campaign newInstance(String campaignSismerLk, Date campaignStartDt, Date campaignEndDt, String campaignNm, String campaignCm, String campaignPositionCm, Timestamp updateDt, Integer remoteId, Collection<Moratorium> moratoria, Collection<CampaignPoint> campaignPoints, Quser quser, Collection<Program> programs, Ship ship, Collection<Occasion> occasions, PositionningSystem positionningSystem, Collection<CampaignLine> campaignLines, Department recorderDepartment, Collection<CampaignArea> campaignAreas)
         {
             final Campaign entity = new CampaignImpl();
             entity.setCampaignSismerLk(campaignSismerLk);
             entity.setCampaignStartDt(campaignStartDt);
             entity.setCampaignEndDt(campaignEndDt);
             entity.setCampaignNm(campaignNm);
             entity.setCampaignCm(campaignCm);
             entity.setCampaignPositionCm(campaignPositionCm);
             entity.setUpdateDt(updateDt);
             entity.setRemoteId(remoteId);
             entity.setMoratoria(moratoria);
             entity.setCampaignPoints(campaignPoints);
             entity.setQuser(quser);
             entity.setPrograms(programs);
             entity.setShip(ship);
             entity.setOccasions(occasions);
             entity.setPositionningSystem(positionningSystem);
             entity.setCampaignLines(campaignLines);
             entity.setRecorderDepartment(recorderDepartment);
             entity.setCampaignAreas(campaignAreas);
             return entity;
         }
     }
 
     /**
      * @see Comparable#compareTo
      */
     public int compareTo(Campaign o)
     {
         int cmp = 0;
         if (this.getCampaignId() != null)
         {
             cmp = this.getCampaignId().compareTo(o.getCampaignId());
         }
         else
         {
             if (this.getCampaignSismerLk() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getCampaignSismerLk().compareTo(o.getCampaignSismerLk()));
             }
             if (this.getCampaignStartDt() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getCampaignStartDt().compareTo(o.getCampaignStartDt()));
             }
             if (this.getCampaignEndDt() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getCampaignEndDt().compareTo(o.getCampaignEndDt()));
             }
             if (this.getCampaignNm() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getCampaignNm().compareTo(o.getCampaignNm()));
             }
             if (this.getCampaignCm() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getCampaignCm().compareTo(o.getCampaignCm()));
             }
             if (this.getCampaignPositionCm() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getCampaignPositionCm().compareTo(o.getCampaignPositionCm()));
             }
             if (this.getUpdateDt() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getUpdateDt().compareTo(o.getUpdateDt()));
             }
             if (this.getRemoteId() != null)
             {
                 cmp = (cmp != 0 ? cmp : this.getRemoteId().compareTo(o.getRemoteId()));
             }
         }
         return cmp;
     }
 // HibernateEntity.vsl merge-point
 // Campaign.java merge-point
 }