1 /*
2 * Copyright (c) 2002-2021, 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.plugins.newsletter.business.portlet;
35
36 import fr.paris.lutece.portal.business.portlet.IPortletInterfaceDAO;
37 import fr.paris.lutece.portal.business.portlet.PortletHome;
38 import fr.paris.lutece.portal.business.portlet.PortletTypeHome;
39 import fr.paris.lutece.portal.service.spring.SpringContextService;
40
41 import java.util.Set;
42
43 /**
44 * This class provides instances management methods for NewsLetterSubscriptionPortlet objects
45 */
46 public class NewsLetterSubscriptionPortletHome extends PortletHome
47 {
48 // This class implements the Singleton design pattern.
49 private static NewsLetterSubscriptionPortletHomet/NewsLetterSubscriptionPortletHome.html#NewsLetterSubscriptionPortletHome">NewsLetterSubscriptionPortletHome _singleton = new NewsLetterSubscriptionPortletHome( );
50
51 // Static variable pointed at the DAO instance
52 private static INewsLetterSubscriptionPortletDAO _dao = SpringContextService.getBean( "newsletter.newsLetterSubscriptionPortletDAO" );
53
54 /**
55 * Returns the identifier of the portlet type
56 *
57 * @return the portlet type identifier
58 */
59 public String getPortletTypeId( )
60 {
61 String strCurrentClassName = this.getClass( ).getName( );
62 String strPortletTypeId = PortletTypeHome.getPortletTypeId( strCurrentClassName );
63
64 return strPortletTypeId;
65 }
66
67 /**
68 * Returns the instance of NewsLetterSubscription Portlet
69 *
70 * @return the NewsLetterSubscription Portlet instance
71 */
72 public static PortletHome getInstance( )
73 {
74 return _singleton;
75 }
76
77 /**
78 * Returns the instance of the portlet DAO singleton
79 *
80 * @return the instance of the DAO singleton
81 */
82 public IPortletInterfaceDAO getDAO( )
83 {
84 return _dao;
85 }
86
87 /**
88 * Associates a new subscription to a given portlet.
89 *
90 * @param nPortletId
91 * the identifier of the portlet.
92 * @param nSubscriptionId
93 * the identifier of the subscription.
94 */
95 public static void insertSubscription( int nPortletId, int nSubscriptionId )
96 {
97 _dao.insertSubscription( nPortletId, nSubscriptionId );
98 }
99
100 /**
101 * De-associate a subscription from a given portlet.
102 *
103 * @param nPortletId
104 * the identifier of the portlet.
105 * @param nIdNewsletter
106 * the identifier of the subscription.
107 */
108 public static void removeNewsletter( int nPortletId, int nIdNewsletter )
109 {
110 _dao.removeSubscription( nPortletId, nIdNewsletter );
111 }
112
113 /**
114 * Returns all the newsletters chosen associated with a given portlet.
115 *
116 * @param nPortletId
117 * the identifier of the portlet.
118 * @return a Set of Integer containing the identifiers.
119 */
120 public static Set<Integer> findSelectedNewsletters( int nPortletId )
121 {
122 return _dao.findSelectedNewsletters( nPortletId );
123 }
124 }