ResourceUserHome.java

/*
 * Copyright (c) 2002-2020, City of Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.plugins.userassignment.business;

import java.util.List;

import fr.paris.lutece.plugins.userassignment.service.UserassignmentPlugin;
import fr.paris.lutece.portal.business.user.AdminUser;
import fr.paris.lutece.portal.service.plugin.Plugin;
import fr.paris.lutece.portal.service.plugin.PluginService;
import fr.paris.lutece.portal.service.spring.SpringContextService;

public final class ResourceUserHome
{

    private static Plugin _plugin = PluginService.getPlugin( UserassignmentPlugin.PLUGIN_NAME );

    private static IResourceUserDAO _dao = SpringContextService.getBean( ResourceUserDAO.BEAN_NAME );

    private ResourceUserHome( )
    {
    }

    /**
     * Creates a resource assignment
     * 
     * @param resourceUser
     *            The resource assignment to create
     * @return The resource assignment which has been created
     */
    public static ResourceUser create( ResourceUser resourceUser )
    {
        _dao.insert( resourceUser, _plugin );

        return resourceUser;
    }

    /**
     * Deactivates a resource assignment
     * 
     * @param resourceUser
     *            The resource assignment to deactivate
     */
    public static void deactivate( ResourceUser resourceUser )
    {
        _dao.deactivateByUserResource( resourceUser.getAdminUser( ).getUserId( ), resourceUser.getIdResource( ), resourceUser.getResourceType( ), _plugin );
    }

    /**
     * <p>
     * Finds the users associated to the specified couple {resource id, resource type}.
     * </p>
     * <p>
     * The result list contains active and inactive resource assignments.
     * </p>
     * 
     * @param nIdResource
     *            the resource id
     * @param strResourceType
     *            the resource type
     * @return the list of unit assignments
     */
    public static List<AdminUser> findUserByResource( int nIdUnit, String strResourceType )
    {
        return _dao.selectUserListByResource( nIdUnit, strResourceType, _plugin );
    }

    /**
     * <p>
     * Finds the resource assignments associated to the specified user.
     * </p>
     * <p>
     * The result list contains active and inactive resource assignments.
     * </p>
     * 
     * @param nIdUser
     *            the user id
     * @return the list of respurce assignments
     */
    public static List<ResourceUser> findByUser( int nIdUser, String resourceType )
    {
        return _dao.selectResourcesByUser( nIdUser, resourceType, _plugin );
    }

    /**
     * <p>
     * Deactivate the resource assignments associated to the specified resource.
     * </p>
     * 
     * @param userId
     * @param resourceID
     *            the resource id
     * @param resourceType
     *            the resource type
     */
    public static void deactivateByUserResource( int userId, int resourceID, String resourceType )
    {
        _dao.deactivateByUserResource( userId, resourceID, resourceType, _plugin );
    }

    /**
     * <p>
     * Delete the resource assignments associated to the specified resource.
     * </p>
     * 
     * @param userId
     * @param resourceID
     *            the resource id
     * @param resourceType
     *            the resource type
     */
    public static void deleteByResource( int resourceID, String resourceType )
    {
        _dao.deleteAssignmentByResource( resourceID, resourceType, _plugin );
    }

}