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
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
40 import java.util.Collection;
41
42 /**
43 * This class provides instances management methods (create, find, ...) for ConfigurationKey objects
44 */
45 public final class ConfigurationKeyHome
46 {
47 // Static variable pointed at the DAO instance
48 private static IConfigurationKeyDAO../../fr/paris/lutece/plugins/pluginwizard/business/IConfigurationKeyDAO.html#IConfigurationKeyDAO">IConfigurationKeyDAO _dao = (IConfigurationKeyDAO) SpringContextService.getPluginBean( "pluginwizard", "pluginwizard.configurationKeyDAO" );
49 private static Plugin _plugin = PluginService.getPlugin( "pluginwizard" );
50
51 /**
52 * Private constructor - this class need not be instantiated
53 */
54 private ConfigurationKeyHome( )
55 {
56 }
57
58 /**
59 * Create an instance of the configurationKey class
60 *
61 * @param configurationKey
62 * The instance of the ConfigurationKey which contains the informations to store
63 * @return The instance of configurationKey which has been created with its primary key.
64 */
65 public static ConfigurationKey/../../../fr/paris/lutece/plugins/pluginwizard/business/ConfigurationKey.html#ConfigurationKey">ConfigurationKey create( ConfigurationKey configurationKey )
66 {
67 _dao.insert( configurationKey, _plugin );
68
69 return configurationKey;
70 }
71
72 /**
73 * Update of the configurationKey which is specified in parameter
74 *
75 * @param configurationKey
76 * The instance of the ConfigurationKey which contains the data to store
77 * @return The instance of the configurationKey which has been updated
78 */
79 public static ConfigurationKey/../../../fr/paris/lutece/plugins/pluginwizard/business/ConfigurationKey.html#ConfigurationKey">ConfigurationKey update( ConfigurationKey configurationKey )
80 {
81 _dao.store( configurationKey, _plugin );
82
83 return configurationKey;
84 }
85
86 /**
87 * Remove the configurationKey whose identifier is specified in parameter
88 *
89 * @param nConfigurationKeyId
90 * The configurationKey Id
91 */
92 public static void remove( int nConfigurationKeyId )
93 {
94 _dao.delete( nConfigurationKeyId, _plugin );
95 }
96
97 // /////////////////////////////////////////////////////////////////////////
98 // Finders
99
100 /**
101 * Returns an instance of a configurationKey whose identifier is specified in parameter
102 *
103 * @param nKey
104 * The configurationKey primary key
105 * @return an instance of ConfigurationKey
106 */
107 public static ConfigurationKey findByPrimaryKey( int nKey )
108 {
109 return _dao.load( nKey, _plugin );
110 }
111
112 /**
113 * Load the data of all the configurationKey objects and returns them in form of a collection
114 *
115 * @return the collection which contains the data of all the configurationKey objects
116 */
117 public static Collection<ConfigurationKey> getConfigurationKeysList( )
118 {
119 return _dao.selectConfigurationKeysList( _plugin );
120 }
121 }