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