/**
 * Abiquo community edition
 * cloud management application for hybrid clouds
 * Copyright (C) 2008-2010 - Abiquo Holdings S.L.
 *
 * This application 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 under
 * version 3 of the License
 *
 * This software 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
 * LESSER GENERAL PUBLIC LICENSE v.3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

package com.abiquo.abiserver.persistence.dao.user;

import java.util.List;

import com.abiquo.abiserver.business.hibernate.pojohb.user.UserHB;
import com.abiquo.abiserver.persistence.DAO;
import com.abiquo.server.core.enterprise.User.AuthType;

/**
 * Specific interface to work with the
 * {@link com.abiquo.abiserver.business.hibernate.pojohb.user.UserHB} Exposes all the methods that
 * this entity will need to interact with the data source
 * 
 * @author jdevesa@abiquo.com
 */
public interface UserDAO extends DAO<UserHB, Integer>
{

    /**
     * Get the user object giving the user name
     * 
     * @param username name of the user
     * @return UserHB object containing the result of the query
     */
    UserHB getUserByUserName(String username);

    /**
     * Gets the user email of the user with the provided name.
     * 
     * @param username name of the user
     * @param the email address of the current user
     */
    String getEmailByUserName(String username);

    /**
     * /** Return the list of users with less privileges than the user, filtering by enterprise
     * 
     * @param privileges privileges of the user
     * @return list of users
     */
    List<UserHB> getUsersByUserPrivileges(String privileges, Integer enterprise);

    /**
     * Return the list of users with the provided role (short description), filtering by enterprise
     * 
     * @param rol, short description of the rol (Public, Sys Admin, User, Enterpirse Admin)
     * @return list of users
     */
    List<UserHB> getUsersByUserRol(String rol, Integer enterprise);

    /**
     * @param name
     * @return UserHB
     * @deprecated use {@link #findUserHBByName(String, String)} which included the authType.
     */
    @Deprecated
    public UserHB findUserHBByName(String name);

    /**
     * Return User with AuthType.
     * 
     * @param username login.
     * @param authType {@link AuthType} value.
     * @return UserHB.
     */
    public UserHB getUserByLoginAuth(String username, String authType);

    /**
     * Return User mail with AuthType.
     * 
     * @param username login.
     * @param authType {@link AuthType} value.
     * @return UserHB.
     */
    String getEmailByUserName(String username, String authType);

    /**
     * Users uniqueness is username + authType.
     * 
     * @param name login.
     * @param authType {@link AuthType} value.
     * @return UserHB
     */
    public UserHB findUserHBByName(String name, String authType);

    /**
     * Users uniqueness is id.
     * 
     * @param name login.
     * @return UserHB
     */
    public UserHB findUserHBById(final Integer id);

    /**
     * Users uniqueness is id + authType.
     * 
     * @param name login.
     * @param authType {@link AuthType} value.
     * @return UserHB
     */
    public UserHB findUserHBById(final Integer id, String authType);

    /**
     * Gets the username and password of the current user.
     * 
     * @param user Current username
     * @param auth Auth type
     * @return An array of two fields [user, password]
     */
    public Object[] getCurrentUserCredentials(String user, String auth);
}