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.rule;
35
36 import java.time.LocalDate;
37 import java.util.List;
38
39 import fr.paris.lutece.portal.service.plugin.Plugin;
40
41 /**
42 * ReservationRule DAO Interface
43 *
44 * @author Laurent Payen
45 *
46 */
47 public interface IReservationRuleDAO
48 {
49
50 /**
51 * Insert a new record in the table
52 *
53 * @param reservationRule
54 * instance of the ReservationRule object to insert
55 * @param plugin
56 * the plugin
57 */
58 void insert( ReservationRule reservationRule, Plugin plugin );
59
60 /**
61 * Update the record in the table
62 *
63 * @param reservationRule
64 * the reference of the ReservationRule
65 * @param plugin
66 * the plugin
67 */
68 void update( ReservationRule appointment, Plugin plugin );
69
70 /**
71 * Delete a record from the table
72 *
73 * @param nIdReservationRule
74 * int identifier of the ReservationRule to delete
75 * @param plugin
76 * the plugin
77 */
78 void delete( int nIdReservationRule, Plugin plugin );
79
80 /**
81 * Load the data from the table
82 *
83 * @param nIdReservationRule
84 * the identifier of the ReservationRule
85 * @param plugin
86 * the plugin
87 * @return the instance of the ReservationRule
88 */
89 ReservationRule select( int nIdReservationRule, Plugin plugin );
90
91 /**
92 * Returns all the Reservation Rule of the form given
93 *
94 * @param nIdForm
95 * the Form Id
96 * @param plugin
97 * the plugin
98 * @return a list of reservation rule of the form
99 */
100 List<ReservationRule> findByIdForm( int nIdForm, Plugin plugin );
101
102 /**
103 * Returns the Reservation Rule with the given search parameters
104 *
105 * @param nIdForm
106 * the Form Id
107 * @param dateOfApply
108 * the date of apply
109 * @param plugin
110 * the plugin
111 * @return the reservation rule that matches
112 */
113 ReservationRule findByIdFormAndDateOfApply( int nIdForm, LocalDate dateOfApply, Plugin plugin );
114
115 /**
116 * Find in database a reservation rule of a form closest to a date
117 *
118 * @param nIdForm
119 * the Form Id
120 * @param dateOfApply
121 * the date of apply
122 * @param plugin
123 * the plugin
124 * @return the reservation rule that matches
125 */
126 ReservationRule findReservationRuleByIdFormAndClosestToDateOfApply( int nIdForm, LocalDate dateOfApply, Plugin plugin );
127
128 }