View Javadoc
1   /*
2    * Copyright (c) 2002-2017, 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.updatercatalog.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.List;
41  
42  
43  /**
44   * This class provides instances management methods (create, find, ...) for PluginRelease objects
45   */
46  public final class PluginReleaseHome
47  {
48      // Static variable pointed at the DAO instance
49      private static IPluginReleaseDAO _dao = (IPluginReleaseDAO) SpringContextService.getPluginBean( "updatercatalog",
50              "updatercatalog.pluginReleaseDAO" );
51      private static Plugin _plugin = PluginService.getPlugin( "updatercatalog" );
52  
53      /**
54       * Private constructor - this class need not be instantiated
55       */
56      private PluginReleaseHome(  )
57      {
58      }
59  
60      /**
61       * Create an instance of the pluginRelease class
62       * @param pluginRelease The instance of the PluginRelease which contains the informations to store
63       * @return The  instance of pluginRelease which has been created with its primary key.
64       */
65      public static PluginRelease create( PluginRelease pluginRelease )
66      {
67          _dao.insert( pluginRelease, _plugin );
68  
69          return pluginRelease;
70      }
71  
72      /**
73       * Update of the pluginRelease data specified in parameter
74       * @param pluginRelease The instance of the PluginRelease which contains the data to store
75       * @return The instance of the  pluginRelease which has been updated
76       */
77      public static PluginRelease update( PluginRelease pluginRelease )
78      {
79          _dao.store( pluginRelease, _plugin );
80  
81          return pluginRelease;
82      }
83  
84      /**
85       * Remove the pluginRelease whose identifier is specified in parameter
86       * @param nPluginReleaseId The pluginRelease Id
87       */
88      public static void remove( int nPluginReleaseId )
89      {
90          _dao.delete( nPluginReleaseId, _plugin );
91      }
92  
93      /**
94       * Add an upgrade to a release
95       * @param nReleaseId The identifier of the pluginRelease
96       * @param upgrade The upgrade
97       */
98      public static void addUpgrade( int nReleaseId, ReleaseUpgrade upgrade )
99      {
100         _dao.addUpgrade( nReleaseId, upgrade, _plugin );
101     }
102 
103     /**
104      * Delete an update from a release
105      * @param nReleaseId The identifier of the pluginRelease
106      * @param strVersionFrom The version
107      */
108     public static void deleteUpgrade( int nReleaseId, String strVersionFrom )
109     {
110         _dao.deleteUpgrade( nReleaseId, strVersionFrom, _plugin );
111     }
112 
113     ///////////////////////////////////////////////////////////////////////////
114     // Finders
115 
116     /**
117      * Returns an instance of a pluginRelease whose identifier is specified in parameter
118      * @param nKey The pluginRelease primary key
119      * @return an instance of PluginRelease
120      */
121     public static PluginRelease findByPrimaryKey( int nKey )
122     {
123         return _dao.load( nKey, _plugin );
124     }
125 
126     /**
127      * Load the data of all the pluginRelease objects and returns them in form of a List
128      * @return the list which contains the data of all the pluginRelease objects
129      */
130     public static List<PluginRelease> findAll(  )
131     {
132         return _dao.selectPluginReleasesList( _plugin );
133     }
134 }