View Javadoc
1   /*
2    * Copyright (c) 2002-2018, 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.appstore.business;
35  
36  import fr.paris.lutece.portal.service.plugin.Plugin;
37  import fr.paris.lutece.portal.service.spring.SpringContextService;
38  
39  import java.util.List;
40  
41  /**
42   * This class provides instances management methods (create, find, ...) for Icon objects
43   */
44  public final class IconHome
45  {
46      // Static variable pointed at the DAO instance
47      private static IIconDAO _dao = (IIconDAO) SpringContextService.getBean( "appstore.iconDAO" );
48  
49      /**
50       * Private constructor - this class need not be instantiated
51       */
52      private IconHome( )
53      {
54      }
55  
56      /**
57       * Creation of an instance of icon
58       *
59       * @param icon
60       *            The instance of icon which contains the informations to store
61       * @param plugin
62       *            the plugin
63       *
64       *
65       *
66       */
67      public static void create( Icon icon, Plugin plugin )
68      {
69          _dao.insert( icon, plugin );
70      }
71  
72      /**
73       * Update of icon which is specified in parameter
74       *
75       * @param icon
76       *            The instance of icon which contains the informations to update
77       * @param plugin
78       *            the Plugin
79       *
80       */
81      public static void update( Icon icon, Plugin plugin )
82      {
83          _dao.store( icon, plugin );
84      }
85  
86      /**
87       * Update metatdata of icon which is specified in parameter
88       *
89       * @param icon
90       *            The instance of icon which contains the informations to update
91       * @param plugin
92       *            the Plugin
93       *
94       */
95      public static void updateMetadata( Icon icon, Plugin plugin )
96      {
97          _dao.storeMetadata( icon, plugin );
98      }
99  
100     /**
101      * remove icon which is specified in parameter
102      *
103      * @param nIdIcon
104      *            The icon key to remove
105      * @param plugin
106      *            the Plugin
107      *
108      */
109     public static void remove( int nIdIcon, Plugin plugin )
110     {
111         _dao.delete( nIdIcon, plugin );
112     }
113 
114     // /////////////////////////////////////////////////////////////////////////
115     // Finders
116 
117     /**
118      * Load the icon Object
119      * 
120      * @param nIdIcon
121      *            the icon id
122      * @param plugin
123      *            the plugin
124      * @return the Icon Object
125      */
126     public static Icon findByPrimaryKey( int nIdIcon, Plugin plugin )
127     {
128         return _dao.load( nIdIcon, plugin );
129     }
130 
131     /**
132      * return the list of all icon
133      * 
134      * @param plugin
135      *            the plugin
136      * @return a list of icon
137      */
138     public static List<Icon> getListIcons( Plugin plugin )
139     {
140         return _dao.selectAll( plugin );
141     }
142 }