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.appointment.business.comment;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.util.ReferenceList;
38
39 import java.sql.Date;
40 import java.util.List;
41
42 /**
43 * ICommentDAO Interface
44 */
45 public interface ICommentDAO
46 {
47 /**
48 * Insert a new record in the table.
49 *
50 * @param comment
51 * instance of the Comment object to insert
52 * @param plugin
53 * the Plugin
54 */
55 void insert( Comment comment, Plugin plugin );
56
57 /**
58 * Update the record in the table
59 *
60 * @param comment
61 * the reference of the Comment
62 * @param plugin
63 * the Plugin
64 */
65 void store( Comment comment, Plugin plugin );
66
67 /**
68 * Delete a record from the table
69 *
70 * @param nKey
71 * The identifier of the Comment to delete
72 * @param plugin
73 * the Plugin
74 */
75 void delete( int nKey, Plugin plugin );
76
77 /**
78 * Delete a list comment from the table
79 *
80 * @param nIdForm
81 * The identifier of the form
82 * @param plugin
83 * the Plugin
84 */
85 void deleteByIdFom( int nIdForm, Plugin plugin );
86
87 ///////////////////////////////////////////////////////////////////////////
88 // Finders
89
90 /**
91 * Load the data from the table
92 *
93 * @param nKey
94 * The identifier of the comment
95 * @param plugin
96 * the Plugin
97 * @return The instance of the comment
98 */
99 Comment load( int nKey, Plugin plugin );
100
101 /**
102 * Load the data from the table
103 *
104 * @param plugin
105 * the plugin
106 * @param startingDate
107 * the date start
108 * @param endingDate
109 * the date end
110 * @param nIdFrom
111 * the id Form
112 * @returnThe list of the comments
113 */
114 List<Comment> selectCommentsList( Plugin plugin, Date startingDate, Date endingDate, int nIdForm );
115
116 /**
117 * Load the data from the table
118 *
119 * @param plugin
120 * the plugin
121 * @param startingDate
122 * the date start
123 * @param endingDate
124 * the date end
125 * @param nIdFrom
126 * the id Form
127 * @returnThe list of the comments
128 */
129 List<Comment> selectCommentsListInclusive( Plugin plugin, Date startingDate, Date endingDate, int nIdForm );
130
131 /**
132 * Load the data of all the comment objects and returns them as a list
133 *
134 * @param plugin
135 * the Plugin
136 * @return The list which contains the data of all the comment objects
137 */
138 List<Comment> selectCommentsList( Plugin plugin );
139
140 /**
141 * Load the id of all the comment objects and returns them as a list
142 *
143 * @param plugin
144 * the Plugin
145 * @return The list which contains the id of all the comment objects
146 */
147 List<Integer> selectIdCommentsList( Plugin plugin );
148
149 /**
150 * Load the data of all the comment objects and returns them as a referenceList
151 *
152 * @param plugin
153 * the Plugin
154 * @return The referenceList which contains the data of all the comment objects
155 */
156 ReferenceList selectCommentsReferenceList( Plugin plugin );
157 }