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.mailinglist;
35
36 import fr.paris.lutece.portal.service.spring.SpringContextService;
37
38 import java.util.Collection;
39 import java.util.List;
40
41
42 /**
43 * This class provides instances management methods (create, find, ...) for MailingList objects
44 */
45 public final class MailingListHome
46 {
47 // Static variable pointed at the DAO instance
48 private static IMailingListDAO _dao = (IMailingListDAO) SpringContextService.getBean( "mailingListDAO" );
49
50 /**
51 * Private constructor - this class need not be instantiated
52 */
53 private MailingListHome( )
54 {
55 }
56
57 /**
58 * Creation of an instance of mailingList
59 *
60 * @param mailingList The instance of the MailingList which contains the informations to store
61 * @return The instance of mailingList which has been created with its primary key.
62 */
63 public static MailingList create( MailingList mailingList )
64 {
65 _dao.insert( mailingList );
66
67 return mailingList;
68 }
69
70 /**
71 * Update of the mailingList which is specified in parameter
72 *
73 * @param mailingList The instance of the MailingList which contains the data to store
74 * @return The instance of the mailingList which has been updated
75 */
76 public static MailingList update( MailingList mailingList )
77 {
78 _dao.store( mailingList );
79
80 return mailingList;
81 }
82
83 /**
84 * Remove the mailingList whose identifier is specified in parameter
85 *
86 * @param nMailingListId The mailingList Id
87 */
88 public static void remove( int nMailingListId )
89 {
90 _dao.delete( nMailingListId );
91 }
92
93 ///////////////////////////////////////////////////////////////////////////
94 // Finders
95
96 /**
97 * Returns an instance of a mailingList whose identifier is specified in parameter
98 *
99 * @param nKey The mailingList primary key
100 * @return an instance of MailingList
101 */
102 public static MailingList findByPrimaryKey( int nKey )
103 {
104 return _dao.load( nKey );
105 }
106
107 /**
108 * Loads the data of all the mailingLists and returns them in form of a collection
109 *
110 * @return the collection which contains the data of all the mailingLists
111 */
112 public static Collection<MailingList> findAll( )
113 {
114 return _dao.selectAll( );
115 }
116
117 /**
118 * Find all mailing lists visible by a workgroup
119 * @param strWorkgroup The workgroup
120 * @return A mailing list collection
121 */
122 public static Collection<MailingList> findByWorkgroup( String strWorkgroup )
123 {
124 return _dao.selectByWorkgroup( strWorkgroup );
125 }
126
127 /**
128 * Add an new user filter to a mailing list
129 * @param filter The filter to add
130 * @param nId The Id of the mailing list
131 */
132 public static void addFilterToMailingList( MailingListUsersFilter filter, int nId )
133 {
134 _dao.insertFilter( filter, nId );
135 }
136
137 /**
138 * Remove an user filter from a mailing list
139 * @param filter The filter to remove
140 * @param nId The Id of the mailing list
141 */
142 public static void deleteFilterToMailingList( MailingListUsersFilter filter, int nId )
143 {
144 _dao.deleteFilter( filter, nId );
145 }
146
147 /**
148 * Check if the filter already exists or not in a mailing list
149 * @param filter the filter
150 * @param nId the id mailing list
151 * @return true if it already exists, false otherwise
152 */
153 public static boolean checkFilter( MailingListUsersFilter filter, int nId )
154 {
155 return _dao.checkFilter( filter, nId );
156 }
157
158 /**
159 * Find by filter.
160 *
161 * @param filter the filter
162 * @return the list
163 */
164 public static List<MailingList> findsByFilter( MailingListFilter filter )
165 {
166 return _dao.selectByFilter( filter );
167 }
168 }