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.mailinglist;
35
36 import java.util.Collection;
37 import java.util.List;
38
39 /**
40 * IMailingListDAO Interface
41 */
42 public interface IMailingListDAO
43 {
44 /**
45 * Insert a new record in the table.
46 *
47 * @param mailingList
48 * instance of the MailingList object to inssert
49 */
50 void insert( MailingList mailingList );
51
52 /**
53 * Update the record in the table
54 *
55 * @param mailingList
56 * the reference of the MailingList
57 */
58 void store( MailingList mailingList );
59
60 /**
61 * Delete a record from the table
62 *
63 * @param nIdMailingList
64 * int identifier of the MailingList to delete
65 */
66 void delete( int nIdMailingList );
67
68 // /////////////////////////////////////////////////////////////////////////
69 // Finders
70
71 /**
72 * load the data of the right from the table
73 *
74 * @param nKey
75 * The identifier of the mailingList
76 * @return The instance of the mailingList
77 */
78 MailingList load( int nKey );
79
80 /**
81 * Loads the data of all the mailingLists and returns them in form of a collection
82 *
83 * @return the collection which contains the data of all the mailingLists
84 */
85 Collection<MailingList> selectAll( );
86
87 /**
88 * Returns all mailing lists having a scope restricted to a given workgroup
89 *
90 * @param strWorkgroup
91 * The workgroup
92 * @return the collection which contains the data of all the mailingLists
93 */
94 Collection<MailingList> selectByWorkgroup( String strWorkgroup );
95
96 /**
97 * Add an users filter to the mailing list
98 *
99 * @param filter
100 * the filter to add
101 * @param nId
102 * The Id of the mailing list
103 */
104 void insertFilter( MailingListUsersFilter filter, int nId );
105
106 /**
107 * Remove an users filter from the mailing list
108 *
109 * @param filter
110 * the filter to remove
111 * @param nId
112 * The Id of the mailing list
113 */
114 void deleteFilter( MailingListUsersFilter filter, int nId );
115
116 /**
117 * Check if the filter already exists or not in the mailing list
118 *
119 * @param filter
120 * the filter
121 * @param nId
122 * the id mailing list
123 * @return true if it already exists, false otherwise
124 */
125 boolean checkFilter( MailingListUsersFilter filter, int nId );
126
127 /**
128 * Select by filter.
129 *
130 * @param filter
131 * the filter
132 * @return the list
133 */
134 List<MailingList> selectByFilter( MailingListFilter filter );
135 }