View Javadoc
1   /*
2    * Copyright (c) 2002-2018, Mairie de 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       * The name of the bean of the DAO
52       */
53      static String BEAN_NAME = "appointment.weekDefinitionDAO";
54  
55      /**
56       * Insert a new record in the table
57       * 
58       * @param appointment
59       *            instance of the WeekDefinition object to insert
60       * @param plugin
61       *            the plugin
62       */
63      void insert( WeekDefinition weekDefinition, Plugin plugin );
64  
65      /**
66       * Update the record in the table
67       * 
68       * @param weekDefinition
69       *            the reference of the WeekDefinition
70       * @param plugin
71       *            the plugin
72       */
73      void update( WeekDefinition weekDefinition, Plugin plugin );
74  
75      /**
76       * Delete a record from the table
77       * 
78       * @param nIdWeekDefinition
79       *            identifier of the WeekDefinition to delete
80       * @param plugin
81       *            the plugin
82       */
83      void delete( int nIdWeekDefinition, Plugin plugin );
84  
85      /**
86       * Load the data from the table
87       * 
88       * @param nIdWeekDefinition
89       *            the identifier of the weekDefinition
90       * @param plugin
91       *            the plugin
92       * @return the instance of the weekDefinition
93       */
94      WeekDefinition select( int nIdWeekDefinition, Plugin plugin );
95  
96      /**
97       * Get all the week definitions of a form
98       * 
99       * @param nIdForm
100      *            the form id
101      * @param plugin
102      *            the plugin
103      * @return a list of all the weekdefinitions of the form given
104      */
105     List<WeekDefinition> findByIdForm( int nIdForm, Plugin plugin );
106 
107     /**
108      * Get the week definitions of a form for the date of apply
109      * 
110      * @param nIdForm
111      *            the form id
112      * @param dateOfApply
113      *            the date of apply
114      * @param plugin
115      *            the plugin
116      * @return the week definition
117      */
118     WeekDefinition findByIdFormAndDateOfApply( int nIdForm, LocalDate dateOfApply, Plugin plugin );
119 
120 }