View Javadoc
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.util.List;
37  
38  import fr.paris.lutece.plugins.appointment.service.AppointmentPlugin;
39  import fr.paris.lutece.portal.service.plugin.Plugin;
40  import fr.paris.lutece.portal.service.plugin.PluginService;
41  import fr.paris.lutece.portal.service.spring.SpringContextService;
42  
43  /**
44   * This class provides instances management methods for Time Slot objects
45   * 
46   * @author Laurent Payen
47   *
48   */
49  public final class TimeSlotHome
50  {
51      // Static variable pointed at the DAO instance
52      private static ITimeSlotDAO _dao = SpringContextService.getBean( "appointment.timeSlotDAO" );
53      private static Plugin _plugin = PluginService.getPlugin( AppointmentPlugin.PLUGIN_NAME );
54  
55      /**
56       * Private constructor - this class does not need to be instantiated
57       */
58      private TimeSlotHome( )
59      {
60      }
61  
62      /**
63       * Create an instance of the TimeSlot class
64       * 
65       * @param timeSlot
66       *            The instance of the TimeSlot which contains the informations to store
67       * @return The instance of the TimeSlot which has been created with its primary key.
68       */
69      public static TimeSlot../../../../../../../fr/paris/lutece/plugins/appointment/business/planning/TimeSlot.html#TimeSlot">TimeSlot create( TimeSlot timeSlot )
70      {
71          _dao.insert( timeSlot, _plugin );
72  
73          return timeSlot;
74      }
75  
76      /**
77       * Update of the TimeSlot which is specified in parameter
78       * 
79       * @param timeSlot
80       *            The instance of the TimeSlot which contains the data to store
81       * @return The instance of the TimeSlot which has been updated
82       */
83      public static TimeSlot../../../../../../../fr/paris/lutece/plugins/appointment/business/planning/TimeSlot.html#TimeSlot">TimeSlot update( TimeSlot timeSlot )
84      {
85          _dao.update( timeSlot, _plugin );
86  
87          return timeSlot;
88      }
89  
90      /**
91       * Delete the TimeSlot whose identifier is specified in parameter
92       * 
93       * @param nKey
94       *            The TimeSlot Id
95       */
96      public static void delete( int nKey )
97      {
98          _dao.delete( nKey, _plugin );
99      }
100 
101     /**
102      * Delete TimeSlot whose id working day is specified in parameter
103      * 
104      * @param nIdWorkingDay
105      *            identifier of the working day
106      */
107     public static void deleteByIdWorkingDay( int nIdWorkingDay )
108     {
109 
110         _dao.deleteByIdWorkingDay( nIdWorkingDay, _plugin );
111     }
112 
113     /**
114      * Returns an instance of the TimeSlot whose identifier is specified in parameter
115      * 
116      * @param nKey
117      *            The TimeSlot primary key
118      * @return an instance of the TimeSlot
119      */
120     public static TimeSlot findByPrimaryKey( int nKey )
121     {
122         return _dao.select( nKey, _plugin );
123     }
124 
125     /**
126      * Get all the time slots of the working day given
127      * 
128      * @param nIdWorkingDay
129      *            the working day id
130      * @return the list of all the time slots of the working day
131      */
132     public static List<TimeSlot> findByIdWorkingDay( int nIdWorkingDay )
133     {
134         return _dao.findByIdWorkingDay( nIdWorkingDay, _plugin );
135     }
136 
137 }