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 * WeekDefinition DAO Interface
43 *
44 * @author Laurent Payen
45 *
46 */
47 public interface IWeekDefinitionDAO
48 {
49
50 /**
51 * Insert a new record in the table
52 *
53 * @param appointment
54 * instance of the WeekDefinition object to insert
55 * @param plugin
56 * the plugin
57 */
58 void insert( WeekDefinition weekDefinition, Plugin plugin );
59
60 /**
61 * Update the record in the table
62 *
63 * @param weekDefinition
64 * the reference of the WeekDefinition
65 * @param plugin
66 * the plugin
67 */
68 void update( WeekDefinition weekDefinition, Plugin plugin );
69
70 /**
71 * Delete a record from the table
72 *
73 * @param nIdWeekDefinition
74 * identifier of the WeekDefinition to delete
75 * @param plugin
76 * the plugin
77 */
78 void delete( int nIdWeekDefinition, Plugin plugin );
79
80 /**
81 * Delete a record from the table
82 *
83 * @param nIdReservationRule
84 * identifier of the reservation rule
85 * @param plugin
86 * the plugin
87 */
88 void deleteByIdReservationRule( int nIdReservationRule, Plugin plugin );
89
90 /**
91 * Load the data from the table
92 *
93 * @param nIdWeekDefinition
94 * the identifier of the weekDefinition
95 * @param plugin
96 * the plugin
97 * @return the instance of the weekDefinition
98 */
99 WeekDefinition select( int nIdWeekDefinition, Plugin plugin );
100
101 /**
102 * Get all the week definitions of a form
103 *
104 * @param nIdForm
105 * the form id
106 * @param plugin
107 * the plugin
108 * @return a list of all the weekdefinitions of the form given
109 */
110 List<WeekDefinition> findByIdForm( int nIdForm, Plugin plugin );
111
112 /**
113 * Get the week definitions of a form for reservation rule
114 *
115 * @param nIdReservationRule
116 * @param plugin
117 * the plugin
118 * @return list of week definition
119 */
120 List<WeekDefinition> findByReservationRule( int nIdReservationRule, Plugin plugin );
121
122 /**
123 * Get the week definitions of a form for the date of apply
124 *
125 * @param nIdForm
126 * the form id
127 * @param dateOfApply
128 * the date of apply
129 * @param plugin
130 * the plugin
131 * @return the week definition
132 */
133 WeekDefinition findByIdFormAndDateOfApply( int nIdForm, LocalDate dateOfApply, Plugin plugin );
134
135 /**
136 * Get the week definitions of a form for the date of apply
137 *
138 * @param nIdReservationRule
139 * the reservationRule id
140 * @param dateOfApply
141 * the date of apply
142 * @param plugin
143 * the plugin
144 * @return the week definition
145 */
146 WeekDefinition findByIdReservationRuleAndDateOfApply( int nIdReservationRule, LocalDate dateOfApply, Plugin plugin );
147
148 }