/*
 * This file is part of LibrePlan
 *
 * Copyright (C) 2009-2010 Fundación para o Fomento da Calidade Industrial e
 *                         Desenvolvemento Tecnolóxico de Galicia
 * Copyright (C) 2010-2012 Igalia, S.L.
 *
 * 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 Affero 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/>.
 */

package org.libreplan.business.users.daos;

import java.util.List;

import org.libreplan.business.common.daos.IGenericDAO;
import org.libreplan.business.common.exceptions.InstanceNotFoundException;
import org.libreplan.business.resources.entities.Worker;
import org.libreplan.business.scenarios.entities.Scenario;
import org.libreplan.business.users.entities.OrderAuthorization;
import org.libreplan.business.users.entities.User;

/**
 * DAO interface for the <code>User</code> entity.
 *
 * @author Fernando Bellas Permuy <fbellas@udc.es>
 * @author Manuel Rego Casasnovas <rego@igalia.com>
 * @author Vova Perebykivskyi <vova@libreplan-enterprise.com>
 */
public interface IUserDAO extends IGenericDAO<User, Long>{

    /**
     * NOTE: Username comparison is case-insensitive.
     */
    public User findByLoginName(String loginName) throws InstanceNotFoundException;

    /**
     * NOTE: Username comparison is case-insensitive, and the method is executed
     * in another transaction.
     */
    public User findByLoginNameAnotherTransaction(String loginName) throws InstanceNotFoundException;

    /**
     * NOTE: Username comparison is case-insensitive.
     */
    public boolean existsByLoginName(String loginName);

    /**
     * NOTE: Username comparison is case-insensitive, and the method is executed
     * in another transaction.
     */
    public boolean existsByLoginNameAnotherTransaction(String loginName);

    /**
     * Finds a User entity by its loginName, among those with the disabled
     * attribute set to false.
     *
     * @param loginName
     *            loginName to perform the search. NOTE: Username comparison is
     *            case-insensitive.
     * @return a {@link User} object.
     * @throws InstanceNotFoundException
     */
    User findByLoginNameNotDisabled(String loginName) throws InstanceNotFoundException;

    /**
     * Retrieves a list of the User entities which attribute 'disabled' has
     * the value false.
     *
     * @return a list of {@link User} object.
     */
    public List<User> listNotDisabled();

    public List<User> findByLastConnectedScenario(Scenario scenario);

    /**
     * Returns the list of {@link User}s not bound to any {@link Worker} yet,
     * plus the {@link User} bound to the {@link Worker} specified as parameter
     * if any.
     */
    List<User> getUnboundUsers(Worker worker);

    User findOnAnotherTransaction(Long id);

    /**
     * Removes all the {@link OrderAuthorization}s of this {@link User} and then
     * removes the {@link User} too
     */
    void remove(User user) throws InstanceNotFoundException;

    List<User> findAll();

    Number getRowCount();
}