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.planning;
35
36 import java.time.LocalDate;
37 import java.util.List;
38
39 import fr.paris.lutece.portal.service.plugin.Plugin;
40
41 /**
42 * ClosingDay DAO Interface
43 *
44 * @author Laurent Payen
45 *
46 */
47 public interface IClosingDayDAO
48 {
49 /**
50 * Insert a new record in the table.
51 *
52 * @param closingDay
53 * instance of the Closing Day object to insert
54 * @param plugin
55 * the Plugin
56 */
57 void insert( ClosingDay closingDay, Plugin plugin );
58
59 /**
60 * Update the record in the table
61 *
62 * @param closingDay
63 * the reference of the Closing Day
64 * @param plugin
65 * the Plugin
66 */
67 void update( ClosingDay closingDay, Plugin plugin );
68
69 /**
70 * Delete a record from the table
71 *
72 * @param nIdClosingDay
73 * int identifier of the Closing Day to delete
74 * @param plugin
75 * the Plugin
76 */
77 void delete( int nIdClosingDay, Plugin plugin );
78
79 /**
80 * Delete a record from the table
81 *
82 * @param nIdForm
83 * the Form Id
84 * @param dateOfCLosingDay
85 * the date of the closing day
86 * @param plugin
87 * the plugin
88 */
89 void deleteByIdFormAndDateOfClosingDay( int nIdForm, LocalDate dateOfCLosingDay, Plugin plugin );
90
91 /**
92 * Delete a record from the table
93 *
94 * @param nIdForm
95 * the Form Id
96 * @param plugin
97 * the plugin
98 */
99 void deleteByIdForm( int nIdForm, Plugin plugin );
100
101 /**
102 * Load the data from the table
103 *
104 * @param nIdClosingDay
105 * The identifier of the Closing Day
106 * @param plugin
107 * the Plugin
108 * @return The instance of the Closing Day
109 */
110 ClosingDay select( int nIdClosingDay, Plugin plugin );
111
112 /**
113 * Return the closing day if exists
114 *
115 * @param nIdForm
116 * the Form Id
117 * @param dateOfCLosingDay
118 * the date of the closing day
119 * @param plugin
120 * the plugin
121 * @return the closing day if exists
122 */
123 ClosingDay findByIdFormAndDateOfClosingDay( int nIdForm, LocalDate dateOfCLosingDay, Plugin plugin );
124
125 /**
126 * Returns the closing days of a form
127 *
128 * @param nIdForm
129 * the form Id
130 * @param plugin
131 * the plugin
132 * @return a list of the closing days of the form
133 */
134 List<ClosingDay> findByIdForm( int nIdForm, Plugin plugin );
135
136 /**
137 * Returns the closing days of the form on a period
138 *
139 * @param nIdForm
140 * the form Id
141 * @param startingDate
142 * the starting date
143 * @param endingDate
144 * the ending date
145 * @param plugin
146 * the plugin
147 * @return the list of the closing days that matches the criteria
148 */
149 List<ClosingDay> findByIdFormAndDateRange( int nIdForm, LocalDate startingDate, LocalDate endingDate, Plugin plugin );
150
151 }