/* * Copyright (c) 2002-2013, 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 ${businessClass.packageName}; 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 ${businessClass.businessClass} objects */ public final class ${businessClass.businessClass}Home { // Static variable pointed at the DAO instance private static I${businessClass.businessClass}DAO _dao = ( I${businessClass.businessClass}DAO ) SpringContextService.getBean( "${businessClass.businessPluginName}.${businessClass.instanceName}DAO" ); private static Plugin _plugin = PluginService.getPlugin( "${businessClass.businessPluginName}" ); /** * Private constructor - this class need not be instantiated */ private ${businessClass.businessClass}Home( ) { } /** * Create an instance of the ${businessClass.instanceName} class * @param ${businessClass.instanceName} The instance of the ${businessClass.businessClass} which contains the informations to store * @return The instance of ${businessClass.instanceName} which has been created with its primary key. */ public static ${businessClass.businessClass} create( ${businessClass.businessClass} ${businessClass.instanceName} ) { _dao.insert( ${businessClass.instanceName}, _plugin ); return ${businessClass.instanceName}; } /** * Update of the ${businessClass.instanceName} which is specified in parameter * @param ${businessClass.instanceName} The instance of the ${businessClass.businessClass} which contains the data to store * @return The instance of the ${businessClass.instanceName} which has been updated */ public static ${businessClass.businessClass} update( ${businessClass.businessClass} ${businessClass.instanceName} ) { _dao.store( ${businessClass.instanceName}, _plugin ); return ${businessClass.instanceName}; } /** * Remove the ${businessClass.instanceName} whose identifier is specified in parameter * @param n${businessClass.businessClass}Id The ${businessClass.instanceName} Id */ public static void remove( int n${businessClass.businessClass}Id ) { _dao.delete( n${businessClass.businessClass}Id, _plugin ); } /////////////////////////////////////////////////////////////////////////// // Finders /** * Returns an instance of a ${businessClass.instanceName} whose identifier is specified in parameter * @param nKey The ${businessClass.instanceName} primary key * @return an instance of ${businessClass.businessClass} */ public static ${businessClass.businessClass} findByPrimaryKey( int nKey ) { return _dao.load( nKey, _plugin); } /** * Load the data of all the ${businessClass.instanceName} objects and returns them in form of a collection * @return the collection which contains the data of all the ${businessClass.instanceName} objects */ public static Collection<${businessClass.businessClass}> get${businessClass.businessClass}sList( ) { return _dao.select${businessClass.businessClass}sList( _plugin ); } }