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.announce.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.List;
39
40 /**
41 * Interface for announce search filter DAO
42 */
43 public interface IAnnounceSearchFilterDAO
44 {
45 /**
46 * Find a filter by primary key
47 *
48 * @param nIdFilter
49 * The id of the filter
50 * @param plugin
51 * The plugin
52 * @return The filter
53 */
54 AnnounceSearchFilter findByPrimaryKey( int nIdFilter, Plugin plugin );
55
56 /**
57 * Insert a new filter into the database
58 *
59 * @param filter
60 * the filter
61 * @param plugin
62 * The plugin
63 */
64 void create( AnnounceSearchFilter filter, Plugin plugin );
65
66 /**
67 * Update a filter
68 *
69 * @param filter
70 * The filter to update
71 * @param plugin
72 * The plugin
73 */
74 void update( AnnounceSearchFilter filter, Plugin plugin );
75
76 /**
77 * Remove a filter from the database
78 *
79 * @param nIdFilter
80 * The id of the filter
81 * @param plugin
82 * The plugin
83 */
84 void delete( int nIdFilter, Plugin plugin );
85
86 /**
87 * Remove filters from the database from the id of categories
88 *
89 * @param nIdCategory
90 * The id of the category
91 * @param plugin
92 * The plugin
93 */
94 void deleteByIdCategory( int nIdCategory, Plugin plugin );
95
96 /**
97 * Get the list of every filters
98 *
99 * @param plugin
100 * The plugin
101 * @return the list of every filters
102 */
103 List<AnnounceSearchFilter> findAll( Plugin plugin );
104
105 /**
106 * Get the list of filters from a list of id
107 *
108 * @param listIdFilters
109 * The list of id of filters
110 * @param plugin
111 * The plugin
112 * @return the list of filters
113 */
114 List<AnnounceSearchFilter> findByListId( List<Integer> listIdFilters, Plugin plugin );
115 }