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

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

/**
 * @deprecated  Use Program2person instead
 * ATTENTION : NE PLUS UTILISER les portefeuilles dans les nouveaux développements (utiliser à la
 * place les privilèves sur les programmes)
 * Portefeuille de navires.
 * Il peut s'agir d'un portefeuille de différent type (enquete d'activité, marées observées en mer,
 * campagne en mer, etc.)
 * Gestion des droits :
 * - Un portefeuille est géré par un seul utilisateur, qui à les droits de lecture/écriture.
 * - Un portefeuille peut etre supervisé par une tierce personne, qui aura également les droits de
 * lecture/écriture sur les données du portefeuille.
 * - Un portefeuille peut avoir plusieurs utilisateurs avec des droits de consultation uniquement
 * (lecture seule) sur ces données.
 */
// HibernateEntity.vsl annotations merge-point
public abstract class ManagedData
    implements Serializable, Comparable<ManagedData>
{
    /**
     * The serial version UID of this class. Needed for serialization.
     */
    private static final long serialVersionUID = -1112639569822803327L;

    // Generate 2 attributes
    private Integer id;

    /**
     * Identifiant unique du portefeuille.
     * @return this.id Integer
     */
    public Integer getId()
    {
        return this.id;
    }

    /**
     * Identifiant unique du portefeuille.
     * @param idIn Integer
     */
    public void setId(Integer idIn)
    {
        this.id = idIn;
    }

    private Timestamp updateDate;

    /**
     * 
     * @return this.updateDate Timestamp
     */
    public Timestamp getUpdateDate()
    {
        return this.updateDate;
    }

    /**
     * 
     * @param updateDateIn Timestamp
     */
    public void setUpdateDate(Timestamp updateDateIn)
    {
        this.updateDate = updateDateIn;
    }

    // Generate 6 associations
    private Collection<VesselManagePeriod> vesselManagePeriods = new HashSet<VesselManagePeriod>();

    /**
     * @deprecated  Use Program2person instead
     * ATTENTION : NE PLUS UTILISER les portefeuilles dans les nouveaux développements (utiliser à
     * la place
     * les privilèves sur les programmes)
     * Définit la présence de navires sur un portefeuille pour une période début/fin.
     * La période utilisée définit la date des données que peut saisir/modifier/visualiser
     * l'utilisateur,
     * en fonction de ses droits.
     * Exemple :
     * Si un utilisateur a un navire A dans un portefeuille pour la période du 01/01/2002 au
     * 31/12/2002, il
     * peut saisir des données même en 2004, si la date de donnée saisie est pendant l'année 2002.
     * @return this.vesselManagePeriods Collection<VesselManagePeriod>
     */
    public Collection<VesselManagePeriod> getVesselManagePeriods()
    {
        return this.vesselManagePeriods;
    }

    /**
     * @deprecated  Use Program2person instead
     * ATTENTION : NE PLUS UTILISER les portefeuilles dans les nouveaux développements (utiliser à
     * la place
     * les privilèves sur les programmes)
     * Définit la présence de navires sur un portefeuille pour une période début/fin.
     * La période utilisée définit la date des données que peut saisir/modifier/visualiser
     * l'utilisateur,
     * en fonction de ses droits.
     * Exemple :
     * Si un utilisateur a un navire A dans un portefeuille pour la période du 01/01/2002 au
     * 31/12/2002, il
     * peut saisir des données même en 2004, si la date de donnée saisie est pendant l'année 2002.
     * @param vesselManagePeriodsIn Collection<VesselManagePeriod>
     */
    public void setVesselManagePeriods(Collection<VesselManagePeriod> vesselManagePeriodsIn)
    {
        this.vesselManagePeriods = vesselManagePeriodsIn;
    }

    /**
     * @deprecated  Use Program2person instead
     * ATTENTION : NE PLUS UTILISER les portefeuilles dans les nouveaux développements (utiliser à
     * la place
     * les privilèves sur les programmes)
     * Définit la présence de navires sur un portefeuille pour une période début/fin.
     * La période utilisée définit la date des données que peut saisir/modifier/visualiser
     * l'utilisateur,
     * en fonction de ses droits.
     * Exemple :
     * Si un utilisateur a un navire A dans un portefeuille pour la période du 01/01/2002 au
     * 31/12/2002, il
     * peut saisir des données même en 2004, si la date de donnée saisie est pendant l'année 2002.
     * @param elementToAdd VesselManagePeriod
     * @return <tt>true</tt> if this collection changed as a result of the
     *         call
     */
    public boolean addVesselManagePeriods(VesselManagePeriod elementToAdd)
    {
        return this.vesselManagePeriods.add(elementToAdd);
    }

    /**
     * @deprecated  Use Program2person instead
     * ATTENTION : NE PLUS UTILISER les portefeuilles dans les nouveaux développements (utiliser à
     * la place
     * les privilèves sur les programmes)
     * Définit la présence de navires sur un portefeuille pour une période début/fin.
     * La période utilisée définit la date des données que peut saisir/modifier/visualiser
     * l'utilisateur,
     * en fonction de ses droits.
     * Exemple :
     * Si un utilisateur a un navire A dans un portefeuille pour la période du 01/01/2002 au
     * 31/12/2002, il
     * peut saisir des données même en 2004, si la date de donnée saisie est pendant l'année 2002.
     * @param elementToRemove VesselManagePeriod
     * @return <tt>true</tt> if this collection changed as a result of the
     *         call
     */
    public boolean removeVesselManagePeriods(VesselManagePeriod elementToRemove)
    {
        return this.vesselManagePeriods.remove(elementToRemove);
    }

    private Collection<Person> viewerUsers = new HashSet<Person>();

    /**
     * <html>
     * <head>
     * <style>
     * p {padding:0px; margin:0px;}
     * </style>
     * </head>
     * <body>
     * <p>
     * Personne liées aux données : utilisateur du système, ou observateurs,
     * responsable de données, etc.
     * </p>
     * <p>
     * </p>
     * <p>
     * Les personnes liées aux activités professionnelles de pêche sont plutôt
     * gérer dans <i>VesselPerson</i>.
     * </p>
     * <p>
     * </p>
     * <p>
     * Nombre de lignes : 100
     * </p>
     * </body>
     * </html>
     * @return this.viewerUsers Collection<Person>
     */
    public Collection<Person> getViewerUsers()
    {
        return this.viewerUsers;
    }

    /**
     * <html>
     * <head>
     * <style>
     * p {padding:0px; margin:0px;}
     * </style>
     * </head>
     * <body>
     * <p>
     * Personne liées aux données : utilisateur du système, ou observateurs,
     * responsable de données, etc.
     * </p>
     * <p>
     * </p>
     * <p>
     * Les personnes liées aux activités professionnelles de pêche sont plutôt
     * gérer dans <i>VesselPerson</i>.
     * </p>
     * <p>
     * </p>
     * <p>
     * Nombre de lignes : 100
     * </p>
     * </body>
     * </html>
     * @param viewerUsersIn Collection<Person>
     */
    public void setViewerUsers(Collection<Person> viewerUsersIn)
    {
        this.viewerUsers = viewerUsersIn;
    }

    /**
     * <html>
     * <head>
     * <style>
     * p {padding:0px; margin:0px;}
     * </style>
     * </head>
     * <body>
     * <p>
     * Personne liées aux données : utilisateur du système, ou observateurs,
     * responsable de données, etc.
     * </p>
     * <p>
     * </p>
     * <p>
     * Les personnes liées aux activités professionnelles de pêche sont plutôt
     * gérer dans <i>VesselPerson</i>.
     * </p>
     * <p>
     * </p>
     * <p>
     * Nombre de lignes : 100
     * </p>
     * </body>
     * </html>
     * @param elementToAdd Person
     * @return <tt>true</tt> if this collection changed as a result of the
     *         call
     */
    public boolean addViewerUsers(Person elementToAdd)
    {
        return this.viewerUsers.add(elementToAdd);
    }

    /**
     * <html>
     * <head>
     * <style>
     * p {padding:0px; margin:0px;}
     * </style>
     * </head>
     * <body>
     * <p>
     * Personne liées aux données : utilisateur du système, ou observateurs,
     * responsable de données, etc.
     * </p>
     * <p>
     * </p>
     * <p>
     * Les personnes liées aux activités professionnelles de pêche sont plutôt
     * gérer dans <i>VesselPerson</i>.
     * </p>
     * <p>
     * </p>
     * <p>
     * Nombre de lignes : 100
     * </p>
     * </body>
     * </html>
     * @param elementToRemove Person
     * @return <tt>true</tt> if this collection changed as a result of the
     *         call
     */
    public boolean removeViewerUsers(Person elementToRemove)
    {
        return this.viewerUsers.remove(elementToRemove);
    }

    private Person managerUser;

    /**
     * <html>
     * <head>
     * <style>
     * p {padding:0px; margin:0px;}
     * </style>
     * </head>
     * <body>
     * <p>
     * Personne liées aux données : utilisateur du système, ou observateurs,
     * responsable de données, etc.
     * </p>
     * <p>
     * </p>
     * <p>
     * Les personnes liées aux activités professionnelles de pêche sont plutôt
     * gérer dans <i>VesselPerson</i>.
     * </p>
     * <p>
     * </p>
     * <p>
     * Nombre de lignes : 100
     * </p>
     * </body>
     * </html>
     * @return this.managerUser Person
     */
    public Person getManagerUser()
    {
        return this.managerUser;
    }

    /**
     * <html>
     * <head>
     * <style>
     * p {padding:0px; margin:0px;}
     * </style>
     * </head>
     * <body>
     * <p>
     * Personne liées aux données : utilisateur du système, ou observateurs,
     * responsable de données, etc.
     * </p>
     * <p>
     * </p>
     * <p>
     * Les personnes liées aux activités professionnelles de pêche sont plutôt
     * gérer dans <i>VesselPerson</i>.
     * </p>
     * <p>
     * </p>
     * <p>
     * Nombre de lignes : 100
     * </p>
     * </body>
     * </html>
     * @param managerUserIn Person
     */
    public void setManagerUser(Person managerUserIn)
    {
        this.managerUser = managerUserIn;
    }

    private Person supervisorUser;

    /**
     * <html>
     * <head>
     * <style>
     * p {padding:0px; margin:0px;}
     * </style>
     * </head>
     * <body>
     * <p>
     * Personne liées aux données : utilisateur du système, ou observateurs,
     * responsable de données, etc.
     * </p>
     * <p>
     * </p>
     * <p>
     * Les personnes liées aux activités professionnelles de pêche sont plutôt
     * gérer dans <i>VesselPerson</i>.
     * </p>
     * <p>
     * </p>
     * <p>
     * Nombre de lignes : 100
     * </p>
     * </body>
     * </html>
     * @return this.supervisorUser Person
     */
    public Person getSupervisorUser()
    {
        return this.supervisorUser;
    }

    /**
     * <html>
     * <head>
     * <style>
     * p {padding:0px; margin:0px;}
     * </style>
     * </head>
     * <body>
     * <p>
     * Personne liées aux données : utilisateur du système, ou observateurs,
     * responsable de données, etc.
     * </p>
     * <p>
     * </p>
     * <p>
     * Les personnes liées aux activités professionnelles de pêche sont plutôt
     * gérer dans <i>VesselPerson</i>.
     * </p>
     * <p>
     * </p>
     * <p>
     * Nombre de lignes : 100
     * </p>
     * </body>
     * </html>
     * @param supervisorUserIn Person
     */
    public void setSupervisorUser(Person supervisorUserIn)
    {
        this.supervisorUser = supervisorUserIn;
    }

    private ManagedDataType managedDataType;

    /**
     * @deprecated  Use Program2person instead
     * ATTENTION : NE PLUS UTILISER les portefeuilles dans les nouveaux développements (utiliser à
     * la place
     * les privilèves sur les programmes)
     * Type de portefeuille. C'est ce type qui permet de déterminer si un utilisateur à les droits
     * en
     * saisie sur une fonctionnalité.
     * Pour la V0, on trouvera les valeurs suivantes :
     * - Calendrier d'activité
     * - Marées observée en mer
     * @return this.managedDataType ManagedDataType
     */
    public ManagedDataType getManagedDataType()
    {
        return this.managedDataType;
    }

    /**
     * @deprecated  Use Program2person instead
     * ATTENTION : NE PLUS UTILISER les portefeuilles dans les nouveaux développements (utiliser à
     * la place
     * les privilèves sur les programmes)
     * Type de portefeuille. C'est ce type qui permet de déterminer si un utilisateur à les droits
     * en
     * saisie sur une fonctionnalité.
     * Pour la V0, on trouvera les valeurs suivantes :
     * - Calendrier d'activité
     * - Marées observée en mer
     * @param managedDataTypeIn ManagedDataType
     */
    public void setManagedDataType(ManagedDataType managedDataTypeIn)
    {
        this.managedDataType = managedDataTypeIn;
    }

    private Collection<ManagedDataTransfer> managedDataTransfers = new HashSet<ManagedDataTransfer>();

    /**
     * @deprecated Use Program2person instead
     * ATTENTION : NE PLUS UTILISER les portefeuilles dans les nouveaux développements (utiliser à
     * la place
     * les privilèves sur les programmes)
     * Cette entité contient les informations indiquant qu'un portefeuille a les mêmes droit qu'un
     * autre.
     * Cette information est utilisée pour la saisie pour que des données saisies par un service
     * puissent
     * toujours être gérées lorsque le service n'existe plus et que ses agents se retrouvent dans
     * d'autres
     * services
     * @return this.managedDataTransfers Collection<ManagedDataTransfer>
     */
    public Collection<ManagedDataTransfer> getManagedDataTransfers()
    {
        return this.managedDataTransfers;
    }

    /**
     * @deprecated Use Program2person instead
     * ATTENTION : NE PLUS UTILISER les portefeuilles dans les nouveaux développements (utiliser à
     * la place
     * les privilèves sur les programmes)
     * Cette entité contient les informations indiquant qu'un portefeuille a les mêmes droit qu'un
     * autre.
     * Cette information est utilisée pour la saisie pour que des données saisies par un service
     * puissent
     * toujours être gérées lorsque le service n'existe plus et que ses agents se retrouvent dans
     * d'autres
     * services
     * @param managedDataTransfersIn Collection<ManagedDataTransfer>
     */
    public void setManagedDataTransfers(Collection<ManagedDataTransfer> managedDataTransfersIn)
    {
        this.managedDataTransfers = managedDataTransfersIn;
    }

    /**
     * @deprecated Use Program2person instead
     * ATTENTION : NE PLUS UTILISER les portefeuilles dans les nouveaux développements (utiliser à
     * la place
     * les privilèves sur les programmes)
     * Cette entité contient les informations indiquant qu'un portefeuille a les mêmes droit qu'un
     * autre.
     * Cette information est utilisée pour la saisie pour que des données saisies par un service
     * puissent
     * toujours être gérées lorsque le service n'existe plus et que ses agents se retrouvent dans
     * d'autres
     * services
     * @param elementToAdd ManagedDataTransfer
     * @return <tt>true</tt> if this collection changed as a result of the
     *         call
     */
    public boolean addManagedDataTransfers(ManagedDataTransfer elementToAdd)
    {
        return this.managedDataTransfers.add(elementToAdd);
    }

    /**
     * @deprecated Use Program2person instead
     * ATTENTION : NE PLUS UTILISER les portefeuilles dans les nouveaux développements (utiliser à
     * la place
     * les privilèves sur les programmes)
     * Cette entité contient les informations indiquant qu'un portefeuille a les mêmes droit qu'un
     * autre.
     * Cette information est utilisée pour la saisie pour que des données saisies par un service
     * puissent
     * toujours être gérées lorsque le service n'existe plus et que ses agents se retrouvent dans
     * d'autres
     * services
     * @param elementToRemove ManagedDataTransfer
     * @return <tt>true</tt> if this collection changed as a result of the
     *         call
     */
    public boolean removeManagedDataTransfers(ManagedDataTransfer elementToRemove)
    {
        return this.managedDataTransfers.remove(elementToRemove);
    }

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

        /**
         * Constructs a new instance of {@link ManagedData}, taking all required and/or
         * read-only properties as arguments, except for identifiers.
         * @param updateDate Timestamp
         * @param managerUser Person
         * @param managedDataType ManagedDataType
         * @return newInstance
         */
        public static ManagedData newInstance(Timestamp updateDate, Person managerUser, ManagedDataType managedDataType)
        {
            final ManagedData entity = new ManagedDataImpl();
            entity.setUpdateDate(updateDate);
            entity.setManagerUser(managerUser);
            entity.setManagedDataType(managedDataType);
            return entity;
        }

        /**
         * Constructs a new instance of {@link ManagedData}, taking all possible properties
         * (except the identifier(s))as arguments.
         * @param updateDate Timestamp
         * @param vesselManagePeriods Collection<VesselManagePeriod>
         * @param viewerUsers Collection<Person>
         * @param managerUser Person
         * @param supervisorUser Person
         * @param managedDataType ManagedDataType
         * @param managedDataTransfers Collection<ManagedDataTransfer>
         * @return newInstance ManagedData
         */
        public static ManagedData newInstance(Timestamp updateDate, Collection<VesselManagePeriod> vesselManagePeriods, Collection<Person> viewerUsers, Person managerUser, Person supervisorUser, ManagedDataType managedDataType, Collection<ManagedDataTransfer> managedDataTransfers)
        {
            final ManagedData entity = new ManagedDataImpl();
            entity.setUpdateDate(updateDate);
            entity.setVesselManagePeriods(vesselManagePeriods);
            entity.setViewerUsers(viewerUsers);
            entity.setManagerUser(managerUser);
            entity.setSupervisorUser(supervisorUser);
            entity.setManagedDataType(managedDataType);
            entity.setManagedDataTransfers(managedDataTransfers);
            return entity;
        }
    }

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