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.modules.resource.business.workflow;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.List;
39
40 /**
41 * Interface for set appointment resource history
42 */
43 public interface ISetAppointmentResourceHistoryDAO
44 {
45 /**
46 * Name of the bean of the implementation of the service
47 */
48 String BEAN_NAME = "appointment-resource.setAppointmentResourceHistoryDAO";
49
50 /**
51 * Create a new history
52 *
53 * @param history
54 * The history to insert into the database
55 * @param plugin
56 * The plugin
57 */
58 void create( SetAppointmentResourceHistory history, Plugin plugin );
59
60 /**
61 * Get an history from its primary key
62 *
63 * @param nId
64 * The primary key
65 * @param plugin
66 * The plugin
67 * @return The history
68 */
69 SetAppointmentResourceHistory findByPrimaryKey( int nId, Plugin plugin );
70
71 /**
72 * Get the list of history associated with a given history id
73 *
74 * @param nIdHistory
75 * The history id
76 * @param plugin
77 * The plugin
78 * @return the list of history, or an empty list if none was found
79 */
80 List<SetAppointmentResourceHistory> findByIdHistory( int nIdHistory, Plugin plugin );
81
82 /**
83 * Remove an history from its primary key
84 *
85 * @param nId
86 * The primary key
87 * @param plugin
88 * the plugin
89 */
90 void delete( int nId, Plugin plugin );
91
92 /**
93 * Remove every history associated with a given appointment
94 *
95 * @param nIdAppointment
96 * The id of the appointment
97 * @param plugin
98 * the plugin
99 */
100 void deleteByIdAppointment( int nIdAppointment, Plugin plugin );
101 }