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.plugin.Plugin;
40 import fr.paris.lutece.portal.service.spring.SpringContextService;
41
42 import java.util.ArrayList;
43
44 /**
45 * This class provides instances management methods for NewsLetterArchivePortlet objects
46 */
47 public class NewsLetterArchivePortletHome extends PortletHome
48 {
49 // This class implements the Singleton design pattern.
50 private static NewsLetterArchivePortletHomeortlet/NewsLetterArchivePortletHome.html#NewsLetterArchivePortletHome">NewsLetterArchivePortletHome _singleton = new NewsLetterArchivePortletHome( );
51
52 // Static variable pointed at the DAO instance
53 private static INewsLetterArchivePortletDAO _dao = SpringContextService.getBean( "newsletter.newsLetterArchivePortletDAO" );
54
55 /**
56 * Constructor
57 */
58 public NewsLetterArchivePortletHome( )
59 {
60 if ( _singleton == null )
61 {
62 _singleton = this;
63 }
64 }
65
66 /**
67 * Returns the identifier of the portlet type
68 *
69 * @return the portlet type identifier
70 */
71 public String getPortletTypeId( )
72 {
73 String strCurrentClassName = this.getClass( ).getName( );
74 String strPortletTypeId = PortletTypeHome.getPortletTypeId( strCurrentClassName );
75
76 return strPortletTypeId;
77 }
78
79 /**
80 * Returns the instance of NewsLetterArchive Portlet
81 *
82 * @return the Archive Portlet instance
83 */
84 public static PortletHome getInstance( )
85 {
86 return _singleton;
87 }
88
89 /**
90 * Returns the instance of the portlet DAO singleton
91 *
92 * @return the instance of the DAO singleton
93 */
94 public IPortletInterfaceDAO getDAO( )
95 {
96 return _dao;
97 }
98
99 /**
100 * Associates a new sending to a given portlet.
101 *
102 * @param nPortletId
103 * the identifier of the portlet.
104 * @param nSendingId
105 * the identifier of the sending.
106 */
107 public static void insertSending( int nPortletId, int nSendingId, Plugin plugin )
108 {
109 _dao.insertSending( nPortletId, nSendingId, plugin );
110 }
111
112 /**
113 * De-associate a sending from a given portlet.
114 *
115 * @param nPortletId
116 * the identifier of the portlet.
117 * @param nSendingId
118 * the identifier of the sending.
119 */
120 public static void removeSending( int nPortletId, int nSendingId, Plugin plugin )
121 {
122 _dao.removeSending( nPortletId, nSendingId, plugin );
123 }
124
125 /**
126 * Returns all the sendings associated with a given portlet.
127 *
128 * @param nPortletId
129 * the identifier of the portlet.
130 * @return a Set of Integer containing the identifiers.
131 */
132 public static ArrayList<Integer> findSendingsInPortlet( int nPortletId, Plugin plugin )
133 {
134 return _dao.findSendingsInPortlet( nPortletId, plugin );
135 }
136 }