UserForm.java

/**
 * Copyright (C) 2008-2010, Squale Project - http://www.squale.org
 *
 * This file is part of Squale.
 *
 * Squale is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or any later version.
 *
 * Squale 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 Lesser General Public License
 * along with Squale.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.squale.squaleweb.applicationlayer.formbean.component;

import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.squale.squalecommon.datatransfertobject.component.ProfileDTO;
import org.squale.squaleweb.applicationlayer.formbean.ActionIdFormSelectable;

/**
 * Repr�sente un utilisateur de l'application
 */
public class UserForm
    extends ActionIdFormSelectable
{

    /**
     * Liste des applications administrables et en cours de cr�ation (ApplicationForm).
     */
    private List mOnlyAdminApplicationsList = new LinkedList();

    /**
     * Liste des applications administrables (ApplicationForm).
     */
    private List mApplicationsList = new LinkedList();

    /**
     * Liste des applications publiques ayant des r�sulats (ApplicationForm).
     */
    private List mPublicApplicationsList = new LinkedList();

    /**
     * Liste des applications ayant des r�sulats (ApplicationForm).
     */
    private List mApplicationsWithResults = new LinkedList();

    /**
     * Liste des acc�s par d�faut
     */
    private ProfileDTO mDefaultAccess = null;

    /**
     * Le nom complet de l'utilisateur
     */
    private String mName = "";

    /**
     * L'adresse e-mail de l'utilisateur
     */
    private String mEmail = "";

    /**
     * Indique si l'utilisateur ne souhaite pas recevoir d'emails automatiques
     */
    private boolean mUnsubscribed;

    /**
     * Le matricule
     */
    private String mMatricule = "";

    /**
     * La liste des applications accessibles � l'utilisateur. La cl� est l'application (ApplicationForm).
     */
    private Map mProfiles = new HashMap();

    /**
     * @return le nom complet de l'utilisateur
     */
    public String getName()
    {
        return mName;
    }

    /**
     * @return l'adresse e-mail.
     */
    public String getEmail()
    {
        return mEmail;
    }

    /**
     * @return le matricule.
     */
    public String getMatricule()
    {
        return mMatricule;
    }

    /**
     * @return la liste des applications (ApplicationForm).
     */
    public List getApplicationsList()
    {
        return mApplicationsList;
    }

    /**
     * @return la liste des applications publiques (ApplicationForm).
     */
    public List getPublicApplicationsList()
    {
        return mPublicApplicationsList;
    }

    /**
     * @return la liste des applications ayant des r�sultats (ApplicationForm).
     */
    public List getApplicationsWithResults()
    {
        return mApplicationsWithResults;
    }

    /**
     * @param pList la liste des applications ayant des r�sultats (ApplicationForm).
     */
    public void setApplicationsWithResults( List pList )
    {
        mApplicationsWithResults = pList;
    }

    /**
     * @param pDefaultAccess la nouvelle liste droits par d�faut.
     */
    public void setDefaultAccess( ProfileDTO pDefaultAccess )
    {
        mDefaultAccess = pDefaultAccess;
    }

    /**
     * @param pEmail le nouvel email.
     */
    public void setEmail( String pEmail )
    {
        mEmail = pEmail;
    }

    /**
     * @param pMatricule le nouveau matricule.
     */
    public void setMatricule( String pMatricule )
    {
        mMatricule = pMatricule;
    }

    /**
     * @param pName le nouveau nom.
     */
    public void setName( String pName )
    {
        mName = pName;
    }

    /**
     * @param pProfiles la nouvelle collection des profils.
     */
    public void setProfiles( Map pProfiles )
    {
        mProfiles = pProfiles;
    }

    /**
     * @param pApplicationsList le nouvelle liste des applications.
     */
    public void setApplicationsList( final List pApplicationsList )
    {
        mApplicationsList = pApplicationsList;
    }

    /**
     * @param pPublicList le nouvelle liste des applications publiques.
     */
    public void setPublicApplicationsList( final List pPublicList )
    {
        mPublicApplicationsList = pPublicList;

    }

    /**
     * @return la collection des profils.
     */
    public Map getProfiles()
    {
        return mProfiles;
    }

    /**
     * @return la liste des droits par d�faut.
     */
    public ProfileDTO getDefaultAccess()
    {
        return mDefaultAccess;
    }

    /**
     * @return la liste des applications administrables et en cours de cr�ation
     */
    public List getOnlyAdminApplicationsList()
    {
        return mOnlyAdminApplicationsList;
    }

    /**
     * @param pOnlyAdminApplicationsList la liste des applications administrables et en cours de cr�ation
     */
    public void setOnlyAdminApplicationsList( List pOnlyAdminApplicationsList )
    {
        mOnlyAdminApplicationsList = pOnlyAdminApplicationsList;
    }

    /**
     * @return true si l'utilisateur s'est d�sabonn� de l'envoi d'email
     */
    public boolean getUnsubscribed()
    {
        return mUnsubscribed;
    }

    /**
     * @param pUnsubscribed true si l'utilisateur s'est d�sabonn� de l'envoi d'email
     */
    public void setUnsubscribed( boolean pUnsubscribed )
    {
        mUnsubscribed = pUnsubscribed;
    }
}