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.form;
35
36 import java.util.List;
37
38 import fr.paris.lutece.portal.service.plugin.Plugin;
39
40 /**
41 * Form DAO Interface
42 *
43 * @author Laurent Payen
44 *
45 */
46 public interface IFormDAO
47 {
48 /**
49 *
50 * Insert a new record in the table
51 *
52 * @param form
53 * instance of the form object to insert
54 * @param plugin
55 * the plugin
56 */
57 void insert( Form form, Plugin plugin );
58
59 /**
60 * Update the record in the table
61 *
62 * @param form
63 * the reference of the form
64 * @param plugin
65 * the plugin
66 */
67 void update( Form form, Plugin plugin );
68
69 /**
70 * Delete a record from the table
71 *
72 * @param nIdFrom
73 * identifier of the form to delete
74 * @param plugin
75 * the plugin
76 */
77 void delete( int nIdForm, Plugin plugin );
78
79 /**
80 * Load the data from the table
81 *
82 * @param nIdCategory
83 * the identifier of the category
84 * @param plugin
85 * the plugin
86 * @return the instance of the Form
87 */
88 List<Form> selectByCategory( int nIdCategory, Plugin plugin );
89
90 /**
91 * Load the data from the table
92 *
93 * @param nIdForm
94 * the identifier of the form
95 * @param plugin
96 * the plugin
97 * @return the instance of the Form
98 */
99 Form select( int nIdForm, Plugin plugin );
100
101 /**
102 * Get all the forms that are active
103 *
104 * @param plugin
105 * the plugin
106 * @return all the active forms
107 */
108 List<Form> findActiveForms( Plugin plugin );
109
110 /**
111 * Get all the forms that are active on displayed on portlet
112 *
113 * @param plugin
114 * the plugin
115 * @return all the active and displayed on portlet forms
116 */
117 List<Form> findActiveAndDisplayedOnPortletForms( Plugin plugin );
118
119 /**
120 * Get all the forms with a given title
121 *
122 * @param strTitle
123 * the Title of the form
124 * @param plugin
125 * the plugin
126 * @return all the forms with this title
127 */
128 List<Form> findByTitle( String strTitle, Plugin plugin );
129
130 /**
131 * Get all the forms
132 *
133 * @param plugin
134 * the plugin
135 * @return all the forms
136 */
137 List<Form> findAllForms( Plugin plugin );
138
139 }