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.service.listeners;
35
36 import java.util.List;
37 import java.util.Locale;
38
39 /**
40 * Interface for listeners that should be notified when appointments are removed or when the date changed. <b>The listener must be a Spring bean.</b>
41 *
42 * @author Laurent Payen
43 *
44 */
45 public interface IAppointmentListener
46 {
47 /**
48 * Notify the listener that an appointment has been removed
49 *
50 * @param nIdAppointment
51 * The id of the appointment
52 */
53 void notifyAppointmentRemoval( int nIdAppointment );
54
55 /**
56 * Notify the listener that the date of an appointment has changed.
57 *
58 * @param nIdAppointment
59 * the id of the appointment
60 * @param nIdSlot
61 * The new slot of the appointment
62 * @param locale
63 * The locale to display error messages with
64 * @return The message to display to the user, if any.
65 */
66 String appointmentDateChanged( int nIdAppointment, List<Integer> listIdSlot, Locale locale );
67
68 /**
69 * Notify the listener that an appointment has been creates
70 *
71 * @param nIdAppointment
72 * The id of the appointment
73 */
74 void notifyAppointmentCreated( int nIdAppointment );
75
76 /**
77 * Notify the listener that an appointment has been update
78 *
79 * @param nIdAppointment
80 * The id of the appointment
81 */
82 void notifyAppointmentUpdated( int nIdAppointment );
83
84 }