View Javadoc
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.model;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  import fr.paris.lutece.portal.service.spring.SpringContextService;
38  
39  import java.util.Collection;
40  
41  /**
42   * This class provides instances management methods (create, find, ...) for PluginModel objects
43   */
44  public final class PluginModelHome
45  {
46      // Static variable pointed at the DAO instance
47      private static IPluginModelDAO _dao = SpringContextService.getBean( "pluginwizard.pluginModelDAO" );
48  
49      /**
50       * Private constructor - this class need not be instantiated
51       */
52      private PluginModelHome( )
53      {
54      }
55  
56      /**
57       * Create an instance of the pluginModel class
58       * 
59       * @param pluginModel
60       *            The instance of the PluginModel which contains the informations to store
61       * @param plugin
62       *            the Plugin
63       * @return The instance of pluginModel which has been created with its primary key.
64       */
65      public static PluginModel../../../../../../fr/paris/lutece/plugins/pluginwizard/business/model/PluginModel.html#PluginModel">PluginModel create( PluginModel pluginModel, Plugin plugin )
66      {
67          _dao.insert( pluginModel, plugin );
68  
69          return pluginModel;
70      }
71  
72      /**
73       * Update of the pluginModel which is specified in parameter
74       * 
75       * @param pluginModel
76       *            The instance of the PluginModel which contains the data to store
77       * @param plugin
78       *            the Plugin
79       * @return The instance of the pluginModel which has been updated
80       */
81      public static PluginModel../../../../../../fr/paris/lutece/plugins/pluginwizard/business/model/PluginModel.html#PluginModel">PluginModel update( PluginModel pluginModel, Plugin plugin )
82      {
83          _dao.store( pluginModel, plugin );
84  
85          return pluginModel;
86      }
87  
88      /**
89       * Remove the pluginModel whose identifier is specified in parameter
90       * 
91       * @param nPluginModelId
92       *            The pluginModel Id
93       * @param plugin
94       *            the Plugin
95       */
96      public static void remove( int nPluginModelId, Plugin plugin )
97      {
98          _dao.delete( nPluginModelId, plugin );
99      }
100 
101     // /////////////////////////////////////////////////////////////////////////
102     // Finders
103 
104     /**
105      * Load the data of all the pluginModel objects and returns them in form of a collection
106      * 
107      * @param plugin
108      *            the Plugin
109      * @return the collection which contains the data of all the pluginModel objects
110      */
111     public static Collection<PluginModel> getPluginModelsList( Plugin plugin )
112     {
113         return _dao.selectPluginModelsList( plugin );
114     }
115 
116     /**
117      * Returns the identifier of the plugin model
118      * 
119      * @param plugin
120      *            The plugin
121      * @param strName
122      *            The name of the generated plugin
123      * @return The identifier of the plugin model
124      */
125     public static int getPluginModelId( Plugin plugin, String strName )
126     {
127         return _dao.selectPluginModelByName( plugin, strName );
128     }
129 
130     /**
131      * A boolean to indicate if plugin exists
132      * 
133      * @param strPluginName
134      *            The plugin name
135      * @param plugin
136      *            The plugin
137      * @return A boolean value indicating if plugin exists
138      */
139     public static boolean pluginExists( String strPluginName, Plugin plugin )
140     {
141         return _dao.pluginExists( strPluginName, plugin );
142     }
143 }