CandidateIdentityHome.java

/*
 * Copyright (c) 2002-2024, 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.identityimport.business;

import fr.paris.lutece.plugins.workflowcore.business.resource.ResourceHistory;
import fr.paris.lutece.portal.service.plugin.Plugin;
import fr.paris.lutece.portal.service.plugin.PluginService;
import fr.paris.lutece.portal.service.spring.SpringContextService;

import java.util.List;
import java.util.Optional;

/**
 * This class provides instances management methods (create, find, ...) for CandidateIdentity objects
 */
public final class CandidateIdentityHome
{
    // Static variable pointed at the DAO instance
    private static ICandidateIdentityDAO _dao = SpringContextService.getBean( "identityimport.candidateIdentityDAO" );
    private static Plugin _plugin = PluginService.getPlugin( "identityimport" );

    /**
     * Private constructor - this class need not be instantiated
     */
    private CandidateIdentityHome( )
    {
    }

    /**
     * Create an instance of the candidateIdentity class
     * 
     * @param candidateIdentity
     *            The instance of the CandidateIdentity which contains the information to store
     * @return The instance of candidateIdentity which has been created with its primary key.
     */
    public static CandidateIdentity create( CandidateIdentity candidateIdentity )
    {
        _dao.insert( candidateIdentity, _plugin );

        return candidateIdentity;
    }

    /**
     * Update of the candidateIdentity which is specified in parameter
     * 
     * @param candidateIdentity
     *            The instance of the CandidateIdentity which contains the data to store
     * @return The instance of the candidateIdentity which has been updated
     */
    public static CandidateIdentity update( CandidateIdentity candidateIdentity )
    {
        _dao.store( candidateIdentity, _plugin );

        return candidateIdentity;
    }

    /**
     * Remove the candidateIdentity whose identifier is specified in parameter
     * 
     * @param nKey
     *            The candidateIdentity Id
     */
    public static void remove( int nKey )
    {
        _dao.delete( nKey, _plugin );
    }

    /**
     * Remove the candidateIdentities whose identifier list is specified in parameter
     *
     * @param idList
     *            The candidateIdentity Id list
     */
    public static void delete( List<Integer> idList )
    {
        _dao.deleteList( idList, _plugin );
    }

    /**
     * Returns an instance of a candidateIdentity whose identifier is specified in parameter
     * 
     * @param nKey
     *            The candidateIdentity primary key
     * @return an instance of CandidateIdentity
     */
    public static Optional<CandidateIdentity> findByPrimaryKey( int nKey )
    {
        return _dao.load( nKey, _plugin );
    }

    /**
     * Load the data of all the candidateIdentity objects and returns them as a list
     * 
     * @return the list which contains the data of all the candidateIdentity objects
     */
    public static List<CandidateIdentity> getCandidateIdentitiesList( )
    {
        return _dao.selectCandidateIdentitiesList( _plugin );
    }

    /**
     * Load the id of all the candidateIdentity objects and returns them as a list
     * 
     * @return the list which contains the id of all the candidateIdentity objects
     */
    public static List<Integer> getIdCandidateIdentitiesList( int nBatchId )
    {
        return _dao.selectIdCandidateIdentitiesList( nBatchId, _plugin );
    }

    /**
     * Load the data of all the avant objects and returns them as a list
     * 
     * @param listIds
     *            liste of ids
     * @return the list which contains the data of all the avant objects
     */
    public static List<CandidateIdentity> getCandidateIdentitiesListByIds( List<Integer> listIds )
    {
        return _dao.selectCandidateIdentitiesListByIds( _plugin, listIds );
    }

    /**
     * Check if external IDs exist in a batch identified by its reference
     *
     * @param externalIds
     *            liste of external ids
     * @return true if one of the given externalIds exists in the batch
     */
    public static boolean checkIfOneExists( final String batchReference, final List<String> externalIds )
    {
        return _dao.checkIfOneExists( _plugin, batchReference, externalIds );
    }

    public static List<ResourceState> getCandidateIdentityStates( final int batchId )
    {
        return _dao.selectIdentityStates( batchId, _plugin );
    }

    public static List<ResourceHistory> getHistory( final int identityId )
    {
        return _dao.getHistory( identityId, _plugin );
    }

    public static ResourceState getIdentityState( final int id )
    {
        return _dao.selectIdentityState( id, _plugin );
    }
}