/* * Copyright (c) 2002-${.now?string('yyyy')}, 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 ${businessObject.packageName}; import fr.paris.lutece.portal.service.plugin.Plugin; import fr.paris.lutece.portal.service.spring.SpringContextService; import java.util.List; /** * This class provides instances management methods (create, find, ...) for ${businessObject.className} objects */ public final class ${businessObject.className}Home { // Static variable pointed at the DAO instance private static I${businessObject.className}DAO _dao = ( I${businessObject.className}DAO ) SpringContextService.getPluginBean( "${businessObject.pluginName}", "${businessObject.instanceName}DAO" ); /** * Private constructor - this class need not be instantiated */ private ${businessObject.className}Home( ) { } /** * Create an instance of the ${businessObject.instanceName} class * @param ${businessObject.instanceName} The instance of the ${businessObject.className} which contains the informations to store * @param plugin the Plugin * @return The instance of ${businessObject.instanceName} which has been created with its primary key. */ public static ${businessObject.className} create( ${businessObject.className} ${businessObject.instanceName}, Plugin plugin ) { _dao.insert( ${businessObject.instanceName}, plugin ); return ${businessObject.instanceName}; } /** * Update of the ${businessObject.instanceName} which is specified in parameter * @param ${businessObject.instanceName} The instance of the ${businessObject.className} which contains the data to store * @param plugin the Plugin * @return The instance of the ${businessObject.instanceName} which has been updated */ public static ${businessObject.className} update( ${businessObject.className} ${businessObject.instanceName}, Plugin plugin ) { _dao.store( ${businessObject.instanceName}, plugin ); return ${businessObject.instanceName}; } /** * Remove the ${businessObject.instanceName} whose identifier is specified in parameter * @param n${businessObject.className}Id The ${businessObject.instanceName} Id * @param plugin the Plugin */ public static void remove( int n${businessObject.className}Id, Plugin plugin ) { _dao.delete( n${businessObject.className}Id, plugin ); } /////////////////////////////////////////////////////////////////////////// // Finders /** * Returns an instance of a ${businessObject.instanceName} whose identifier is specified in parameter * @param nKey The ${businessObject.instanceName} primary key * @param plugin the Plugin * @return an instance of ${businessObject.className} */ public static ${businessObject.className} findByPrimaryKey( int nKey, Plugin plugin ) { return _dao.load( nKey, plugin); } /** * Load the data of all the ${businessObject.instanceName} objects and returns them in form of a list * @param plugin the Plugin * @return the list which contains the data of all the ${businessObject.instanceName} objects */ public static List<${businessObject.className}> get${businessObject.className}sList( Plugin plugin ) { return _dao.select${businessObject.className}sList( plugin ); } }