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;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.List;
39
40 /**
41 * Interface for appointment form resource type DAO
42 */
43 public interface IAppointmentFormResourceTypeDAO
44 {
45 /**
46 * Name of the bean of the implementation of the DAO
47 */
48 String BEAN_NAME = "appointment-resource.appointmentFormResourceTypeDAO";
49
50 /**
51 * Create an association between an appointment form and a resource type
52 *
53 * @param formResourceType
54 * The appointment form resource type
55 * @param plugin
56 * the plugin
57 */
58 void insert( AppointmentFormResourceType formResourceType, Plugin plugin );
59
60 /**
61 * Update an existing appointment form resource type
62 *
63 * @param formResourceType
64 * the form resource type
65 * @param plugin
66 * the plugin
67 */
68 void update( AppointmentFormResourceType formResourceType, Plugin plugin );
69
70 /**
71 * Remove an association between an appointment form and a resource type
72 *
73 * @param nId
74 * The id of the appointment form resource type to remove
75 * @param plugin
76 * the plugin
77 */
78 void remove( int nId, Plugin plugin );
79
80 /**
81 * Remove every associations between an appointment form and resource types
82 *
83 * @param nIdAppointmentForm
84 * The id of the appointment form
85 * @param plugin
86 * The plugin
87 */
88 void removeFromIdAppointmentForm( int nIdAppointmentForm, Plugin plugin );
89
90 /**
91 * Find an appointment form resource type from its primary key
92 *
93 * @param nId
94 * the id of the appointment form resource type to get
95 * @param plugin
96 * The plugin
97 * @return The appointment form resource type, or null if no appointment form with the given id was found
98 */
99 AppointmentFormResourceType findByPrimaryKey( int nId, Plugin plugin );
100
101 /**
102 * Get the list of resource types associated with a given form
103 *
104 * @param nIdForm
105 * The id of the form
106 * @param plugin
107 * The plugin
108 * @return The list of resources associated with the given form, or an empty list if no resource is associated with this form
109 */
110 List<AppointmentFormResourceType> findResourceTypesListFromIdForm( int nIdForm, Plugin plugin );
111
112 /**
113 * Reset the form resource type that was declared as containing the admin user of appointments
114 *
115 * @param nIdAppointmentForm
116 * The id of the appointment form
117 * @param plugin
118 * The plugin
119 */
120 void resetAppAdminUser( int nIdAppointmentForm, Plugin plugin );
121
122 /**
123 * Reset the form resource type that was declared as containing the localization of appointments
124 *
125 * @param nIdAppointmentForm
126 * The id of the appointment form
127 * @param plugin
128 * The plugin
129 */
130 void resetLocalization( int nIdAppointmentForm, Plugin plugin );
131 }