IndicatorHistoryHome.java

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

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.Collection;


/**
 * This class provides instances management methods (create, find, ...) for IndicatorHistory objects
 */
public final class IndicatorHistoryHome
{
    // Static variable pointed at the DAO instance
    private static IIndicatorHistoryDAO _dao = SpringContextService.getBean( "indicator.indicatorHistoryDAO" );
    private static Plugin _plugin = PluginService.getPlugin( "indicator" );

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

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

        return indicatorHistory;
    }

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

        return indicatorHistory;
    }

    /**
     * Remove the indicatorHistory whose identifier is specified in parameter
     * @param strKey The Key
     * @param strTimeCode  The Timecode
     */
    public static void remove( String strKey, String strTimeCode )
    {
        _dao.delete( strKey, strTimeCode, _plugin );
    }

    ///////////////////////////////////////////////////////////////////////////
    // Finders

    /**
     * Returns an instance of a indicatorHistory whose identifier is specified in parameter
     * @param strKey The Key
     * @param strTimeCode  The Timecode
     * @return an instance of IndicatorHistory
     */
    public static IndicatorHistory findByPrimaryKey( String strKey, String strTimeCode )
    {
        return _dao.load( strKey, strTimeCode, _plugin );
    }

    /**
     * Load the data of all the indicatorHistory objects and returns them in form of a collection
     * @param strKey The indicator key
     * @return the collection which contains the data of all the indicatorHistory objects
     */
    public static Collection<IndicatorHistory> getIndicatorHistorysList( String strKey )
    {
        return _dao.selectIndicatorHistorysList( strKey, _plugin );
    }
}