ConfigurationKeyHome.java

  1. /*
  2.  * Copyright (c) 2002-2022, City of 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.pluginwizard.business;

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

  38. import java.util.Collection;

  39. /**
  40.  * This class provides instances management methods (create, find, ...) for ConfigurationKey objects
  41.  */
  42. public final class ConfigurationKeyHome
  43. {
  44.     // Static variable pointed at the DAO instance
  45.     private static IConfigurationKeyDAO _dao = (IConfigurationKeyDAO) SpringContextService.getPluginBean( "pluginwizard", "pluginwizard.configurationKeyDAO" );
  46.     private static Plugin _plugin = PluginService.getPlugin( "pluginwizard" );

  47.     /**
  48.      * Private constructor - this class need not be instantiated
  49.      */
  50.     private ConfigurationKeyHome( )
  51.     {
  52.     }

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

  63.         return configurationKey;
  64.     }

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

  75.         return configurationKey;
  76.     }

  77.     /**
  78.      * Remove the configurationKey whose identifier is specified in parameter
  79.      *
  80.      * @param nConfigurationKeyId
  81.      *            The configurationKey Id
  82.      */
  83.     public static void remove( int nConfigurationKeyId )
  84.     {
  85.         _dao.delete( nConfigurationKeyId, _plugin );
  86.     }

  87.     // /////////////////////////////////////////////////////////////////////////
  88.     // Finders

  89.     /**
  90.      * Returns an instance of a configurationKey whose identifier is specified in parameter
  91.      *
  92.      * @param nKey
  93.      *            The configurationKey primary key
  94.      * @return an instance of ConfigurationKey
  95.      */
  96.     public static ConfigurationKey findByPrimaryKey( int nKey )
  97.     {
  98.         return _dao.load( nKey, _plugin );
  99.     }

  100.     /**
  101.      * Load the data of all the configurationKey objects and returns them in form of a collection
  102.      *
  103.      * @return the collection which contains the data of all the configurationKey objects
  104.      */
  105.     public static Collection<ConfigurationKey> getConfigurationKeysList( )
  106.     {
  107.         return _dao.selectConfigurationKeysList( _plugin );
  108.     }
  109. }