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 /**
41 * This class provides instances management methods (create, find, ...) for Model objects
42 */
43 public final class ModelHome
44 {
45 // Static variable pointed at the DAO instance
46 private static IModelDAO _dao = SpringContextService.getBean( "pluginwizard.modelDAO" );
47 private static Plugin _plugin = PluginService.getPlugin( "pluginwizard" );
48
49 /**
50 * Private constructor - this class need not be instantiated
51 */
52 private ModelHome( )
53 {
54 }
55
56 /**
57 * Check if a plugin already exists
58 *
59 * @param strPluginName
60 * The plugin name
61 * @return -1 if not exists, otherwise the plugin id
62 */
63 public static int exists( String strPluginName )
64 {
65 for ( Model model : _dao.selectModelsList( _plugin ) )
66 {
67 if ( model.getName( ).equals( strPluginName ) )
68 {
69 return model.getIdPlugin( );
70 }
71 }
72
73 return -1;
74 }
75
76 /**
77 * Create an instance of the model class
78 *
79 * @param model
80 * The instance of the Model which contains the informations to store
81 * @return The instance of model which has been created with its primary key.
82 */
83 public static Modelf="../../../../../../fr/paris/lutece/plugins/pluginwizard/business/Model.html#Model">Model create( Model model )
84 {
85 _dao.insert( model, _plugin );
86
87 return model;
88 }
89
90 /**
91 * Update of the model which is specified in parameter
92 *
93 * @param model
94 * The instance of the Model which contains the data to store
95 * @return The instance of the model which has been updated
96 */
97 public static Modelf="../../../../../../fr/paris/lutece/plugins/pluginwizard/business/Model.html#Model">Model update( Model model )
98 {
99 _dao.store( model, _plugin );
100
101 return model;
102 }
103
104 /**
105 * Remove the model whose identifier is specified in parameter
106 *
107 * @param nModelId
108 * The model Id
109 */
110 public static void remove( int nModelId )
111 {
112 _dao.delete( nModelId, _plugin );
113 }
114
115 // /////////////////////////////////////////////////////////////////////////
116 // Finders
117
118 /**
119 * Returns an instance of a model whose identifier is specified in parameter
120 *
121 * @param nKey
122 * The model primary key
123 * @return an instance of Model
124 */
125 public static Model findByPrimaryKey( int nKey )
126 {
127 return _dao.load( nKey, _plugin );
128 }
129 }