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.util.List;
37  
38  import fr.paris.lutece.portal.service.plugin.Plugin;
39  
40  /**
41   * TimeSlot DAO Interface
42   * 
43   * @author Laurent Payen
44   *
45   */
46  public interface ITimeSlotDAO
47  {
48  
49      /**
50       * The name of the bean of the DAO
51       */
52      static String BEAN_NAME = "appointment.timeSlotDAO";
53  
54      /**
55       * Insert a new record in the table
56       * 
57       * @param timeSlot
58       *            instance of the timeSlot object to insert
59       * @param plugin
60       *            the plugin
61       */
62      void insert( TimeSlot timeSlot, Plugin plugin );
63  
64      /**
65       * Update the record in the table
66       * 
67       * @param timeSlot
68       *            the reference of the timeSlot
69       * @param plugin
70       *            the plugin
71       */
72      void update( TimeSlot timeSlot, Plugin plugin );
73  
74      /**
75       * Delete a record from the table
76       * 
77       * @param nIdTimeSlot
78       *            identifier of the timeSlot to delete
79       * @param plugin
80       *            the plugin
81       */
82      void delete( int nIdTimeSlot, Plugin plugin );
83  
84      /**
85       * Load the data from the table
86       * 
87       * @param nIdTimeSlot
88       *            the identifier of the timeSlot
89       * @param plugin
90       *            the plugin
91       * @return the instance of the timeSlot
92       */
93      TimeSlot select( int nIdTimeSlot, Plugin plugin );
94  
95      /**
96       * Get all the time slots of the working day
97       * 
98       * @param nIdWorkingDay
99       *            the working day id
100      * @param plugin
101      *            the plugin
102      * @return the list of all the time slots of the working day
103      */
104     List<TimeSlot> findByIdWorkingDay( int nIdWorkingDay, Plugin plugin );
105 }