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.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 * This class provides instances management methods (create, find, ...) for PortletType objects
45 */
46 public final class PortletTypeHome
47 {
48 // Static variable pointed at the DAO instance
49 private static IPortletTypeDAO _dao = SpringContextService.getBean( "portletTypeDAO" );
50
51 /**
52 * Creates a new PortletTypeHome object.
53 */
54 private PortletTypeHome( )
55 {
56 }
57
58 /**
59 * Creation of an instance of an PortletType
60 *
61 * @param portletType
62 * 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../../../../../fr/paris/lutece/portal/business/portlet/PortletType.html#PortletType">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
76 * The identifier of the portlet type to remove
77 */
78 public static void remove( String strPortletTypeId )
79 {
80 _dao.delete( strPortletTypeId );
81 }
82
83 // /////////////////////////////////////////////////////////////////////////
84 // Finders
85
86 /**
87 * Returns an instance of an portletType whose identifier is specified in parameter
88 *
89 * @param strKey
90 * The Primary Key of the portletType
91 * @return an instance of portletType
92 */
93 public static PortletType findByPrimaryKey( String strKey )
94 {
95 return _dao.load( strKey );
96 }
97
98 /**
99 * Return the id of a portlet type
100 *
101 * @param strPluginHomeClass
102 * The identifier of the portlet
103 * @return The order max
104 */
105 public static String getPortletTypeId( String strPluginHomeClass )
106 {
107 return _dao.selectPortletTypeId( strPluginHomeClass );
108 }
109
110 /**
111 * Search the number of portlet type for a portlet
112 *
113 * @param strPortletTypeId
114 * The Type Id of portlet
115 * @return int
116 */
117 public static int getNbPortletTypeByPortlet( String strPortletTypeId )
118 {
119 return _dao.selectNbPortletTypeByPortlet( strPortletTypeId );
120 }
121
122 /**
123 * Returns the list of the portlet types
124 *
125 * @param locale
126 * The locale
127 * @return the list of portlet types
128 */
129 public static ReferenceList getPortletsTypesList( Locale locale )
130 {
131 return _dao.selectPortletsTypesList( locale );
132 }
133
134 /**
135 * Returns the list of the portlet types
136 *
137 * @param locale
138 * The locale
139 * @return the list of portlet types
140 */
141 public static List<PortletType> getPortletTypesList( Locale locale )
142 {
143 List<PortletType> list = _dao.selectPortletTypesList( );
144 I18nService.localizeCollection( list, locale );
145
146 return list;
147 }
148 }