TemplateHome.java

  1. /*
  2.  * Copyright (c) 2002-2014, Mairie de Paris
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  *  1. Redistributions of source code must retain the above copyright notice
  10.  *     and the following disclaimer.
  11.  *
  12.  *  2. Redistributions in binary form must reproduce the above copyright notice
  13.  *     and the following disclaimer in the documentation and/or other materials
  14.  *     provided with the distribution.
  15.  *
  16.  *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
  17.  *     contributors may be used to endorse or promote products derived from
  18.  *     this software without specific prior written permission.
  19.  *
  20.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21.  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23.  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
  24.  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25.  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26.  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27.  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28.  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29.  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30.  * POSSIBILITY OF SUCH DAMAGE.
  31.  *
  32.  * License 1.0
  33.  */
  34. package fr.paris.lutece.plugins.phraseanet.business.template;

  35. import fr.paris.lutece.plugins.phraseanet.service.Constants;
  36. import fr.paris.lutece.portal.service.plugin.Plugin;
  37. import fr.paris.lutece.portal.service.plugin.PluginService;
  38. import fr.paris.lutece.portal.service.spring.SpringContextService;

  39. import java.util.List;


  40. /**
  41.  * This class provides instances management methods (create, find, ...) for Template objects
  42.  */
  43. public final class TemplateHome
  44. {
  45.     // Static variable pointed at the DAO instance
  46.     private static ITemplateDAO _dao = (ITemplateDAO) SpringContextService.getBean(
  47.             "phraseanet.templateDAO" );
  48.     private static Plugin _plugin = PluginService.getPlugin( Constants.PLUGIN_NAME );

  49.     /**
  50.      * Private constructor - this class need not be instantiated
  51.      */
  52.     private TemplateHome(  )
  53.     {
  54.     }

  55.     /**
  56.      * Create an instance of the Template class
  57.      * @param template The instance of the Template which contains the informations to store
  58.      * @return The  instance of Template which has been created with its primary key.
  59.      */
  60.     public static Template create( Template template )
  61.     {
  62.         _dao.insert( template, _plugin );

  63.         return template;
  64.     }

  65.     /**
  66.      * Update of the Template data specified in parameter
  67.      * @param template The instance of the Template which contains the data to store
  68.      * @return The instance of the  Template which has been updated
  69.      */
  70.     public static Template update( Template template )
  71.     {
  72.         _dao.store( template, _plugin );

  73.         return template;
  74.     }

  75.     /**
  76.      * Remove the Template whose identifier is specified in parameter
  77.      * @param nTemplateId The Template Id
  78.      */
  79.     public static void remove( int nTemplateId )
  80.     {
  81.         _dao.delete( nTemplateId, _plugin );
  82.     }

  83.     ///////////////////////////////////////////////////////////////////////////
  84.     // Finders

  85.     /**
  86.      * Returns an instance of a Template whose identifier is specified in parameter
  87.      * @param strMediaType The Template media type
  88.      * @return an instance of Template
  89.      */
  90.     public static Template findByPrimaryKey( String strMediaType )
  91.     {
  92.         return _dao.load( strMediaType, _plugin );
  93.     }

  94.     /**
  95.      * Load the data of all the Template objects and returns them in form of a collection
  96.      * @return the list which contains the data of all the Template objects
  97.      */
  98.     public static List<Template> findAll(  )
  99.     {
  100.         return _dao.selectTemplatesList( _plugin );
  101.     }
  102. }