/*
     * #%L
     * Quadrige3 Core
     * %%
     * Copyright (C) 2017 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%
    */
  //
  /**
   * @author Generated on 07/22/2024 16:45:05+0200 Do not modify by hand!
   *
   * TEMPLATE:     ValueObject.vsl in andromda-java-cartridge.
   * MODEL CLASS:  Données::fr.ifremer.quadrige3.core::vo::data::survey::CampaignVO
   * STEREOTYPE:   ValueObject
   */
  package fr.ifremer.quadrige3.core.vo.data.survey;
  
  import java.io.Serializable;
  import java.sql.Timestamp;
  import java.util.Arrays;
  import java.util.Date;
  import org.apache.commons.lang3.builder.CompareToBuilder;
  import org.apache.commons.lang3.builder.EqualsBuilder;
  import org.apache.commons.lang3.builder.HashCodeBuilder;
  import org.apache.commons.lang3.builder.ToStringBuilder;
  
  /**
   * TODO: Model Documentation for class CampaignVO
   */
  public class CampaignVO
      implements Serializable, Comparable<CampaignVO>
  {
      /** The serial version UID of this class. Needed for serialization. */
      private static final long serialVersionUID = 3930695978259017781L;
  
      // Class attributes
      /** TODO: Model Documentation for attribute campaignId */
      protected Integer campaignId;
      /** TODO: Model Documentation for attribute campaignNm */
      protected String campaignNm;
      /** TODO: Model Documentation for attribute campaignStartDt */
      protected Date campaignStartDt;
      /** TODO: Model Documentation for attribute campaignEndDt */
      protected Date campaignEndDt;
      /** TODO: Model Documentation for attribute campaignSismerLk */
      protected String campaignSismerLk;
      /** TODO: Model Documentation for attribute campaignCm */
      protected String campaignCm;
      /** TODO: Model Documentation for attribute campaignPositionCm */
      protected String campaignPositionCm;
      /** TODO: Model Documentation for attribute quserId */
      protected Integer quserId;
      /** TODO: Model Documentation for attribute recDepId */
      protected Integer recDepId;
      /** TODO: Model Documentation for attribute updateDt */
      protected Timestamp updateDt;
  
      // Class associationEnds
      /** TODO: Model Documentation for attribute occasionVOs */
      protected OccasionVO[] occasionVOs;
  
      /** Default Constructor with no properties */
      public CampaignVO()
      {
          // Documented empty block - avoid compiler warning - no super constructor
      }
  
      /**
       * Constructor taking only required properties
       * @param campaignIdIn Integer
       * @param campaignNmIn String
       * @param campaignStartDtIn Date
       * @param quserIdIn Integer
       * @param recDepIdIn Integer
       */
      public CampaignVO(final Integer campaignIdIn, final String campaignNmIn, final Date campaignStartDtIn, final Integer quserIdIn, final Integer recDepIdIn)
      {
          this.campaignId = campaignIdIn;
          this.campaignNm = campaignNmIn;
          this.campaignStartDt = campaignStartDtIn;
          this.quserId = quserIdIn;
          this.recDepId = recDepIdIn;
      }
  
      /**
       * Constructor with all properties
      * @param campaignIdIn Integer
      * @param campaignNmIn String
      * @param campaignStartDtIn Date
      * @param campaignEndDtIn Date
      * @param campaignSismerLkIn String
      * @param campaignCmIn String
      * @param campaignPositionCmIn String
      * @param quserIdIn Integer
      * @param recDepIdIn Integer
      * @param updateDtIn Timestamp
      * @param occasionVOsIn OccasionVO[]
      */
     public CampaignVO(final Integer campaignIdIn, final String campaignNmIn, final Date campaignStartDtIn, final Date campaignEndDtIn, final String campaignSismerLkIn, final String campaignCmIn, final String campaignPositionCmIn, final Integer quserIdIn, final Integer recDepIdIn, final Timestamp updateDtIn, final OccasionVO[] occasionVOsIn)
     {
         this.campaignId = campaignIdIn;
         this.campaignNm = campaignNmIn;
         this.campaignStartDt = campaignStartDtIn;
         this.campaignEndDt = campaignEndDtIn;
         this.campaignSismerLk = campaignSismerLkIn;
         this.campaignCm = campaignCmIn;
         this.campaignPositionCm = campaignPositionCmIn;
         this.quserId = quserIdIn;
         this.recDepId = recDepIdIn;
         this.updateDt = updateDtIn;
         this.occasionVOs = occasionVOsIn;
     }
 
     /**
      * Copies constructor from other CampaignVO
      *
      * @param otherBean Cannot be <code>null</code>
      * @throws NullPointerException if the argument is <code>null</code>
      */
     public CampaignVO(final CampaignVO otherBean)
     {
         this.campaignId = otherBean.getCampaignId();
         this.campaignNm = otherBean.getCampaignNm();
         this.campaignStartDt = otherBean.getCampaignStartDt();
         this.campaignEndDt = otherBean.getCampaignEndDt();
         this.campaignSismerLk = otherBean.getCampaignSismerLk();
         this.campaignCm = otherBean.getCampaignCm();
         this.campaignPositionCm = otherBean.getCampaignPositionCm();
         this.quserId = otherBean.getQuserId();
         this.recDepId = otherBean.getRecDepId();
         this.updateDt = otherBean.getUpdateDt();
         this.occasionVOs = otherBean.getOccasionVOs();
     }
 
     /**
      * Copies all properties from the argument value object into this value object.
      * @param otherBean Cannot be <code>null</code>
      */
     public void copy(final CampaignVO otherBean)
     {
         if (null != otherBean)
         {
             this.setCampaignId(otherBean.getCampaignId());
             this.setCampaignNm(otherBean.getCampaignNm());
             this.setCampaignStartDt(otherBean.getCampaignStartDt());
             this.setCampaignEndDt(otherBean.getCampaignEndDt());
             this.setCampaignSismerLk(otherBean.getCampaignSismerLk());
             this.setCampaignCm(otherBean.getCampaignCm());
             this.setCampaignPositionCm(otherBean.getCampaignPositionCm());
             this.setQuserId(otherBean.getQuserId());
             this.setRecDepId(otherBean.getRecDepId());
             this.setUpdateDt(otherBean.getUpdateDt());
             this.setOccasionVOs(otherBean.getOccasionVOs());
         }
     }
 
     /**
      * TODO: Model Documentation for attribute campaignId
      * Get the campaignId Attribute
      * @return campaignId Integer
      */
     public Integer getCampaignId()
     {
         return this.campaignId;
     }
 
     /**
      * 
      * @param value Integer
      */
     public void setCampaignId(final Integer value)
     {
         this.campaignId = value;
     }
 
     /**
      * TODO: Model Documentation for attribute campaignNm
      * Get the campaignNm Attribute
      * @return campaignNm String
      */
     public String getCampaignNm()
     {
         return this.campaignNm;
     }
 
     /**
      * 
      * @param value String
      */
     public void setCampaignNm(final String value)
     {
         this.campaignNm = value;
     }
 
     /**
      * TODO: Model Documentation for attribute campaignStartDt
      * Get the campaignStartDt Attribute
      * @return campaignStartDt Date
      */
     public Date getCampaignStartDt()
     {
         return this.campaignStartDt;
     }
 
     /**
      * 
      * @param value Date
      */
     public void setCampaignStartDt(final Date value)
     {
         this.campaignStartDt = value;
     }
 
     /**
      * TODO: Model Documentation for attribute campaignEndDt
      * Get the campaignEndDt Attribute
      * @return campaignEndDt Date
      */
     public Date getCampaignEndDt()
     {
         return this.campaignEndDt;
     }
 
     /**
      * 
      * @param value Date
      */
     public void setCampaignEndDt(final Date value)
     {
         this.campaignEndDt = value;
     }
 
     /**
      * TODO: Model Documentation for attribute campaignSismerLk
      * Get the campaignSismerLk Attribute
      * @return campaignSismerLk String
      */
     public String getCampaignSismerLk()
     {
         return this.campaignSismerLk;
     }
 
     /**
      * 
      * @param value String
      */
     public void setCampaignSismerLk(final String value)
     {
         this.campaignSismerLk = value;
     }
 
     /**
      * TODO: Model Documentation for attribute campaignCm
      * Get the campaignCm Attribute
      * @return campaignCm String
      */
     public String getCampaignCm()
     {
         return this.campaignCm;
     }
 
     /**
      * 
      * @param value String
      */
     public void setCampaignCm(final String value)
     {
         this.campaignCm = value;
     }
 
     /**
      * TODO: Model Documentation for attribute campaignPositionCm
      * Get the campaignPositionCm Attribute
      * @return campaignPositionCm String
      */
     public String getCampaignPositionCm()
     {
         return this.campaignPositionCm;
     }
 
     /**
      * 
      * @param value String
      */
     public void setCampaignPositionCm(final String value)
     {
         this.campaignPositionCm = value;
     }
 
     /**
      * TODO: Model Documentation for attribute quserId
      * Get the quserId Attribute
      * @return quserId Integer
      */
     public Integer getQuserId()
     {
         return this.quserId;
     }
 
     /**
      * 
      * @param value Integer
      */
     public void setQuserId(final Integer value)
     {
         this.quserId = value;
     }
 
     /**
      * TODO: Model Documentation for attribute recDepId
      * Get the recDepId Attribute
      * @return recDepId Integer
      */
     public Integer getRecDepId()
     {
         return this.recDepId;
     }
 
     /**
      * 
      * @param value Integer
      */
     public void setRecDepId(final Integer value)
     {
         this.recDepId = value;
     }
 
     /**
      * TODO: Model Documentation for attribute updateDt
      * Get the updateDt Attribute
      * @return updateDt Timestamp
      */
     public Timestamp getUpdateDt()
     {
         return this.updateDt;
     }
 
     /**
      * 
      * @param value Timestamp
      */
     public void setUpdateDt(final Timestamp value)
     {
         this.updateDt = value;
     }
 
     /**
      * TODO: Model Documentation for association occasionVOs
      * Get the occasionVOs Association
      * This accessor method returns a reference to the live list,
      * not a snapshot. Therefore any modification you make to the
      * returned list will be present inside the object.
      * @return this.occasionVOs OccasionVO[]
      */
     public OccasionVO[] getOccasionVOs()
     {
         return this.occasionVOs;
     }
 
     /**
      * Sets the occasionVOs
      * @param value OccasionVO[]
      */
     public void setOccasionVOs(OccasionVO[] value)
     {
         this.occasionVOs = value;
     }
 
     /**
      * @param object to compare this object against
      * @return boolean if equal
      * @see Object#equals(Object)
      */
     @Override
     public boolean equals(final Object object)
     {
         if (object==null || object.getClass() != this.getClass())
         {
              return false;
         }
         // Check if the same object instance
         if (object==this)
         {
             return true;
         }
         CampaignVO rhs = (CampaignVO) object;
         return new EqualsBuilder()
             .append(this.getCampaignId(), rhs.getCampaignId())
             .append(this.getCampaignNm(), rhs.getCampaignNm())
             .append(this.getCampaignStartDt(), rhs.getCampaignStartDt())
             .append(this.getCampaignEndDt(), rhs.getCampaignEndDt())
             .append(this.getCampaignSismerLk(), rhs.getCampaignSismerLk())
             .append(this.getCampaignCm(), rhs.getCampaignCm())
             .append(this.getCampaignPositionCm(), rhs.getCampaignPositionCm())
             .append(this.getQuserId(), rhs.getQuserId())
             .append(this.getRecDepId(), rhs.getRecDepId())
             .append(this.getUpdateDt(), rhs.getUpdateDt())
             .append(this.getOccasionVOs(), rhs.getOccasionVOs())
             .isEquals();
     }
 
     /**
      * @param object to compare this object against
      * @return int if equal
      * @see Comparable#compareTo(Object)
      */
     public int compareTo(final CampaignVO object)
     {
         if (object==null)
         {
             return -1;
         }
         // Check if the same object instance
         if (object==this)
         {
             return 0;
         }
         return new CompareToBuilder()
             .append(this.getCampaignId(), object.getCampaignId())
             .append(this.getCampaignNm(), object.getCampaignNm())
             .append(this.getCampaignStartDt(), object.getCampaignStartDt())
             .append(this.getCampaignEndDt(), object.getCampaignEndDt())
             .append(this.getCampaignSismerLk(), object.getCampaignSismerLk())
             .append(this.getCampaignCm(), object.getCampaignCm())
             .append(this.getCampaignPositionCm(), object.getCampaignPositionCm())
             .append(this.getQuserId(), object.getQuserId())
             .append(this.getRecDepId(), object.getRecDepId())
             .append(this.getUpdateDt(), object.getUpdateDt())
             .append(this.getOccasionVOs(), object.getOccasionVOs())
             .toComparison();
     }
 
     /**
      * @return int hashCode value
      * @see Object#hashCode()
      */
     @Override
     public int hashCode()
     {
         return new HashCodeBuilder(1249046965, -82296885)
             .append(this.getCampaignId())
             .append(this.getCampaignNm())
             .append(this.getCampaignStartDt())
             .append(this.getCampaignEndDt())
             .append(this.getCampaignSismerLk())
             .append(this.getCampaignCm())
             .append(this.getCampaignPositionCm())
             .append(this.getQuserId())
             .append(this.getRecDepId())
             .append(this.getUpdateDt())
             //Commented out to avoid commons-lang-2.4 recursion StackOverflowError: https://issues.apache.org/jira/browse/LANG-456
             //.append(this.getOccasionVOs())
             .toHashCode();
     }
 
     /**
      * @return String representation of object
      * @see Object#toString()
      */
     @Override
     public String toString()
     {
         return new ToStringBuilder(this)
             .append("campaignId", this.getCampaignId())
             .append("campaignNm", this.getCampaignNm())
             .append("campaignStartDt", this.getCampaignStartDt())
             .append("campaignEndDt", this.getCampaignEndDt())
             .append("campaignSismerLk", this.getCampaignSismerLk())
             .append("campaignCm", this.getCampaignCm())
             .append("campaignPositionCm", this.getCampaignPositionCm())
             .append("quserId", this.getQuserId())
             .append("recDepId", this.getRecDepId())
             .append("updateDt", this.getUpdateDt())
             .append("occasionVOs", this.getOccasionVOs())
             .toString();
     }
 
     /**
      * This is a convenient helper method which is able to detect whether or not two values are equal. Two values
      * are equal when they are both {@code null}, are arrays of the same length with equal elements or are
      * equal objects (this includes {@link java.util.Collection} and {@link java.util.Map} instances).
      *
      * <p/>Note that for array, collection or map instances the comparison runs one level deep.
      *
      * @param first the first object to compare, may be {@code null}
      * @param second the second object to compare, may be {@code null}
      * @return this method will return {@code true} in case both objects are equal as explained above;
      *      in all other cases this method will return {@code false}
      */
     protected static boolean equal(final Object first, final Object second)
     {
         final boolean equal;
 
         if (first == null)
         {
             equal = (second == null);
         }
         else if (first.getClass().isArray() && (second != null) && second.getClass().isArray())
         {
             equal = Arrays.equals((Object[])first, (Object[])second);
         }
         else // note that the following also covers java.util.Collection and java.util.Map
         {
             equal = first.equals(second);
         }
 
         return equal;
     }
 
     // CampaignVO value-object java merge-point
 }