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.plugins.genericattributes.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.List;
39
40 /**
41 *
42 * interface IResponseDAO
43 *
44 */
45 public interface IResponseDAO
46 {
47 /**
48 * Insert a new record in the table.
49 *
50 * @param response
51 * instance of the Response object to insert
52 * @param plugin
53 * the plugin
54 */
55 void insert( Response response, Plugin plugin );
56
57 /**
58 * Load the data of the response from the table
59 *
60 * @param nIdResponse
61 * The identifier of the entry
62 * @param plugin
63 * the plugin
64 * @return the instance of the Entry
65 */
66 Response load( int nIdResponse, Plugin plugin );
67
68 /**
69 * Delete a response from its id
70 *
71 * @param nIdResponse
72 * The identifier of the response
73 * @param plugin
74 * the plugin
75 */
76 void delete( int nIdResponse, Plugin plugin );
77
78 /**
79 * Update the the response in the table
80 *
81 * @param response
82 * instance of the response object to update
83 * @param plugin
84 * the plugin
85 */
86 void store( Response response, Plugin plugin );
87
88 /**
89 * Load the data of all the response who verify the filter and returns them in a list
90 *
91 * @param filter
92 * the filter
93 * @param plugin
94 * the plugin
95 * @return the list of response
96 */
97 List<Response> selectListByFilter( ResponseFilter filter, Plugin plugin );
98
99 /**
100 * return a list of statistic on the entry
101 *
102 * @param nIdEntry
103 * the id of the entry
104 * @param plugin
105 * the plugin
106 * @return return a list of statistic on the entry
107 */
108 List<StatisticEntrySubmit> getStatisticByIdEntry( int nIdEntry, Plugin plugin );
109
110 /**
111 * Get the max number from a given id resource
112 *
113 * @param nIdEntry
114 * the id of the entry
115 * @param plugin
116 * {@link Plugin}
117 * @return the max number
118 */
119 int getMaxNumber( int nIdEntry, Plugin plugin );
120 }