DemandHome.java

/*
 * Copyright (c) 2002-2019, Mairie de 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.appcenter.business;

import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import fr.paris.lutece.plugins.appcenter.service.DemandTypeService;
import fr.paris.lutece.plugins.workflowcore.business.state.State;
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 fr.paris.lutece.portal.service.util.AppLogService;
import fr.paris.lutece.portal.service.workflow.WorkflowService;
import fr.paris.lutece.util.ReferenceList;
import java.io.IOException;
import java.util.ArrayList;

import java.util.List;

/**
 * This class provides instances management methods (create, find, ...) for Demand objects
 */
public final class DemandHome
{
    // Static variable pointed at the DAO instance
    private static IDemandDAO _dao = SpringContextService.getBean( "appcenter.demandDAO" );
    private static Plugin _plugin = PluginService.getPlugin( "appcenter" );
    private static ObjectMapper _mapper = new ObjectMapper( );

    static
    {
        _mapper.configure( DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false );
    }

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

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

        return demand;
    }

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

        return demand;
    }

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

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

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

    /**
     * Load the data of all the demand objects and returns them as a list
     * 
     * @return the list which contains the data of all the demand objects
     */
    public static List<Demand> getDemandsList( )
    {
        return _dao.selectDemandsList( _plugin );
    }

    /**
     * Load the data of all the demand objects and returns them as a list
     * 
     * @param nIdApplication
     *            the id of the application
     * @return the list which contains the data of all the demand objects
     */
    public static List<Demand> getDemandsListByApplication( int nIdApplication )
    {
        return _dao.selectDemandsListByApplication( nIdApplication, _plugin );
    }

    /**
     * Load the data of all the demand objects and returns them as a list
     * 
     * @param nIdApplication
     *            the id of the application
     * @param strDemandType
     *            the type of the demand
     * @param demandClass
     *            the class
     * @return the list which contains the data of all the demand objects
     */
    public static <T extends Demand> List<T> getDemandsListByApplicationAndType( int nIdApplication, String strDemandType, Class<T> demandClass )
    {
        return _dao.selectDemandsListByApplicationAndType( nIdApplication, strDemandType, demandClass, _plugin );
    }

    /**
     * Load the id of all the demand objects and returns them as a list
     * 
     * @return the list which contains the id of all the demand objects
     */
    public static List<Integer> getIdDemandsList( )
    {
        return _dao.selectIdDemandsList( _plugin );
    }

    /**
     * Load the data of all the demand objects and returns them as a referenceList
     * 
     * @return the referenceList which contains the data of all the demand objects
     */
    public static ReferenceList getDemandsReferenceList( )
    {
        return _dao.selectDemandsReferenceList( _plugin );
    }

    public static <T extends Demand> List<T> getListFullDemandsByIdApplication( int nIdApplication )
    {
        return _dao.selectListFullDemands( nIdApplication, DemandTypeHome.getDemandTypesList( ), _plugin );
    }

    /**
     * Load the data of all the demand objects and returns them as a list
     * 
     * @param filter
     * @return the list which contains the data of all the demand objects
     */
    public static List<Demand> getDemandsListByFilter( DemandFilter filter )
    {
        List<Demand> filteredDemandList = _dao.selectDemandsListByFilter( filter, _plugin );

        if ( filter.hasState( ) )
        {
            List<Demand> demandList = new ArrayList<>( );

            for ( Demand demand : filteredDemandList )
            {
                int nIdWorkflow = DemandTypeService.getIdWorkflow( demand.getDemandType( ) );
                State state = WorkflowService.getInstance( ).getState( demand.getId( ), Demand.WORKFLOW_RESOURCE_TYPE, nIdWorkflow, -1 );
                if ( filter.getState( ).equals( state.getName( ) ) )
                {
                    demandList.add( demand );
                }
            }

            return demandList;
        }

        return filteredDemandList;
    }
}