AdminUserFieldHome.java

/*
 * Copyright (c) 2002-2022, 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.portal.business.user.attribute;

import fr.paris.lutece.portal.business.file.FileHome;
import fr.paris.lutece.portal.business.user.AdminUser;
import fr.paris.lutece.portal.service.spring.SpringContextService;

import java.util.List;

/**
 *
 * AdminUserFieldHome
 *
 */
public final class AdminUserFieldHome
{
    private static IAdminUserFieldDAO _dao = SpringContextService.getBean( "adminUserFieldDAO" );

    /**
     * Private constructor
     */
    private AdminUserFieldHome( )
    {
    }

    /**
     * Load the user field
     * 
     * @param nIdUserField
     *            ID
     * @return AdminUserField
     */
    public static AdminUserField findByPrimaryKey( int nIdUserField )
    {
        return _dao.load( nIdUserField );
    }

    /**
     * Insert a new user field
     * 
     * @param userField
     *            the user field
     */
    public static void create( AdminUserField userField )
    {
        if ( userField.getFile( ) != null )
        {
            userField.getFile( ).setIdFile( FileHome.create( userField.getFile( ) ) );
        }

        _dao.insert( userField );
    }

    /**
     * Update an user field
     * 
     * @param userField
     *            the user field
     */
    public static void update( AdminUserField userField )
    {
        if ( userField.getFile( ) != null )
        {
            FileHome.update( userField.getFile( ) );
        }

        _dao.store( userField );
    }

    /**
     * Delete an attribute.
     *
     * @param userField
     *            the user field
     */
    public static void remove( AdminUserField userField )
    {
        if ( userField != null )
        {
            if ( userField.getFile( ) != null )
            {
                FileHome.remove( userField.getFile( ).getIdFile( ) );
            }

            _dao.delete( userField.getIdUserField( ) );
        }
    }

    /**
     * Delete all user fields from given id field
     * 
     * @param nIdField
     *            id field
     */
    public static void removeUserFieldsFromIdField( int nIdField )
    {
        _dao.deleteUserFieldsFromIdField( nIdField );
    }

    /**
     * Delete all user fields from given id user
     * 
     * @param nIdUser
     *            id user
     */
    public static void removeUserFieldsFromIdUser( int nIdUser )
    {
        _dao.deleteUserFieldsFromIdUser( nIdUser );
    }

    /**
     * Delete all user fields from given id attribute
     * 
     * @param nIdAttribute
     *            id attribute
     */
    public static void removeUserFieldsFromIdAttribute( int nIdAttribute )
    {
        _dao.deleteUserFieldsFromIdAttribute( nIdAttribute );
    }

    /**
     * Load all the user field by a given ID user and a given ID attribute
     * 
     * @param nIdUser
     *            the ID user
     * @param nIdAttribute
     *            the attribute identifier
     * @return a list of adminuserfield
     */
    public static List<AdminUserField> selectUserFieldsByIdUserIdAttribute( int nIdUser, int nIdAttribute )
    {
        return _dao.selectUserFieldsByIdUserIdAttribute( nIdUser, nIdAttribute );
    }

    /**
     * Load users by a given filter
     * 
     * @param auFieldFilter
     *            the filter
     * @return a list of users
     */
    public static List<AdminUser> findUsersByFilter( AdminUserFieldFilter auFieldFilter )
    {
        return _dao.selectUsersByFilter( auFieldFilter );
    }

    /**
     * Select by filter
     * 
     * @param auFieldFilter
     *            the filter
     * @return a list of admin user field
     */
    public static List<AdminUserField> findByFilter( AdminUserFieldFilter auFieldFilter )
    {
        return _dao.selectByFilter( auFieldFilter );
    }

    /**
     * Remove by filter
     * 
     * @param auFieldFilter
     *            the filter
     */
    public static void removeByFilter( AdminUserFieldFilter auFieldFilter )
    {
        List<AdminUserField> listUserFields = findByFilter( auFieldFilter );

        for ( AdminUserField userField : listUserFields )
        {
            remove( userField );
        }
    }

    /**
     * Is the file associated with an attribute
     *
     * @param nIdFile
     *            the id file
     * @return wheter the file is associated with an attribute
     */
    public static boolean existsWithFile( int nIdFile )
    {
        return _dao.existsWithFile( nIdFile );
    }

}