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 java.util.Collection;
37
38 import fr.paris.lutece.portal.service.spring.SpringContextService;
39 import fr.paris.lutece.util.ReferenceList;
40
41 /**
42 * This class provides instances management methods for AliasPortlet objects
43 */
44 public class AliasPortletHome extends PortletHome
45 {
46 // ///////////////////////////////////////////////////////////////////////////////
47 // Constants
48 // Static variable pointed at the DAO instance
49 private static IAliasPortletDAO _dao = SpringContextService.getBean( "aliasPortletDAO" );
50
51 /** This class implements the Singleton design pattern. */
52 private static AliasPortletHome _singleton;
53
54 /**
55 * Constructor
56 */
57 protected AliasPortletHome( )
58 {
59 if ( _singleton == null )
60 {
61 _singleton = this;
62 }
63 }
64
65 /**
66 * Returns the identifier of the alias portlet type
67 *
68 * @return the portlet type identifier
69 */
70 public String getPortletTypeId( )
71 {
72 String strCurrentClassName = this.getClass( ).getName( );
73 return PortletTypeHome.getPortletTypeId( strCurrentClassName );
74 }
75
76 /**
77 * Returns the instance of AliasPortletHome
78 *
79 * @return the AliasPortletHome instance
80 */
81 public static synchronized PortletHome getInstance( )
82 {
83 if ( _singleton == null )
84 {
85 _singleton = new AliasPortletHome( );
86 }
87 return _singleton;
88 }
89
90 /**
91 * Returns the instance of the FolderListingPortletDAO singleton
92 *
93 * @return the instance of the FolderListingPortletDAO
94 */
95 public IPortletInterfaceDAO getDAO( )
96 {
97 return _dao;
98 }
99
100 /**
101 * Returns the portlet alias identifier of the portlet whose identifier is specified in parameter
102 *
103 * @param nIdPortlet
104 * the identifier of the portlet
105 * @return the identifier of the alias portlet
106 */
107 public static int getAliasId( int nIdPortlet )
108 {
109 return _dao.selectAliasId( nIdPortlet );
110 }
111
112 /**
113 * Returns the Reference list of the portlets which accept an alias
114 *
115 * @return the list of the portlets in form of ReferenceList
116 */
117 public static ReferenceList getAcceptAliasPortletRefList( )
118 {
119 return _dao.selectAcceptAliasPortletRefList( );
120 }
121
122 /**
123 * Returns the list of the portlets which accept an alias
124 *
125 * @return the list of the portlets
126 */
127 public static Collection<Portlet> getAcceptAliasPortletList( )
128 {
129 return _dao.selectAcceptAliasPortletList( );
130 }
131
132 /**
133 * Loads the list of the portlets whose type is the same as the one specified in parameter
134 *
135 * @param strPortletTypeId
136 * the portlet type identifier
137 * @return the list of the portlets in form of a ReferenceList
138 */
139 public static ReferenceList getPortletsByTypeList( String strPortletTypeId )
140 {
141 return _dao.selectPortletsByTypeList( strPortletTypeId );
142 }
143 }