1 /*
2 * Copyright (c) 2002-2014, 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.portal.business.portlet;
35
36 import fr.paris.lutece.portal.service.i18n.I18nService;
37 import fr.paris.lutece.portal.service.spring.SpringContextService;
38 import fr.paris.lutece.util.ReferenceList;
39
40 import java.util.List;
41 import java.util.Locale;
42
43
44 /**
45 * This class provides instances management methods (create, find, ...) for PortletType objects
46 */
47 public final class PortletTypeHome
48 {
49 // Static variable pointed at the DAO instance
50 private static IPortletTypeDAO _dao = (IPortletTypeDAO) SpringContextService.getBean( "portletTypeDAO" );
51
52 /**
53 * Creates a new PortletTypeHome object.
54 */
55 private PortletTypeHome( )
56 {
57 }
58
59 /**
60 * Creation of an instance of an PortletType
61 *
62 * @param portletType An instance of the PortletType which contains the informations to store
63 * @return The instance of PortletType which has been created with its primary key.
64 */
65 public static PortletType create( PortletType portletType )
66 {
67 _dao.insert( portletType );
68
69 return portletType;
70 }
71
72 /**
73 * Remove the portlet type whose identifier is specified in parameter
74 *
75 * @param strPortletTypeId The identifier of the portlet type to remove
76 */
77 public static void remove( String strPortletTypeId )
78 {
79 _dao.delete( strPortletTypeId );
80 }
81
82 ///////////////////////////////////////////////////////////////////////////
83 // Finders
84
85 /**
86 * Returns an instance of an portletType whose identifier is specified in parameter
87 *
88 * @param strKey The Primary Key of the portletType
89 * @return an instance of portletType
90 */
91 public static PortletType findByPrimaryKey( String strKey )
92 {
93 return _dao.load( strKey );
94 }
95
96 /**
97 * Return the id of a portlet type
98 *
99 * @param strPluginHomeClass The identifier of the portlet
100 * @return The order max
101 */
102 public static String getPortletTypeId( String strPluginHomeClass )
103 {
104 return _dao.selectPortletTypeId( strPluginHomeClass );
105 }
106
107 /**
108 * Search the number of portlet type for a portlet
109 *
110 * @param strPortletTypeId The Type Id of portlet
111 * @return int
112 */
113 public static int getNbPortletTypeByPortlet( String strPortletTypeId )
114 {
115 return _dao.selectNbPortletTypeByPortlet( strPortletTypeId );
116 }
117
118 /**
119 * Returns the list of the portlet types
120 *
121 * @param locale The locale
122 * @return the list of portlet types
123 */
124 public static ReferenceList getPortletsTypesList( Locale locale )
125 {
126 return _dao.selectPortletsTypesList( locale );
127 }
128
129 /**
130 * Returns the list of the portlet types
131 *
132 * @param locale The locale
133 * @return the list of portlet types
134 */
135 public static List<PortletType> getPortletTypesList( Locale locale )
136 {
137 List<PortletType> list = _dao.selectPortletTypesList( );
138 I18nService.localizeCollection( list, locale );
139
140 return list;
141 }
142 }