1 /*
2 * Copyright (c) 2002-2020, 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.elasticdata.modules.forms.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import java.util.List;
38
39 /**
40 * IOptionalQuestionIndexationDAO Interface
41 */
42 public interface IOptionalQuestionIndexationDAO
43 {
44 /**
45 * Insert a new record in the table.
46 *
47 * @param optionalQuestionIndexation
48 * instance of the OptionalQuestionIndexation object to insert
49 * @param plugin
50 * the Plugin
51 */
52 void insert( OptionalQuestionIndexation optionalQuestionIndexation, Plugin plugin );
53
54 /**
55 * Update the record in the table
56 *
57 * @param optionalQuestionIndexation
58 * the reference of the OptionalQuestionIndexation
59 * @param plugin
60 * the Plugin
61 */
62 void store( OptionalQuestionIndexation optionalQuestionIndexation, Plugin plugin );
63
64 /**
65 * Delete a record from the table
66 *
67 * @param nKey
68 * The identifier of the OptionalQuestionIndexation to delete
69 * @param plugin
70 * the Plugin
71 */
72 void delete( int nKey, Plugin plugin );
73
74 ///////////////////////////////////////////////////////////////////////////
75 // Finders
76
77 /**
78 * Load the data from the table
79 *
80 * @param nKey
81 * The identifier of the optionalQuestionIndexation
82 * @param plugin
83 * the Plugin
84 * @return The instance of the optionalQuestionIndexation
85 */
86 OptionalQuestionIndexation load( int nKey, Plugin plugin );
87
88 /**
89 * Load the data from the table
90 *
91 * @param nQuestionId
92 * The identifier of the question
93 * @param plugin
94 * the Plugin
95 * @return The instance of the optionalQuestionIndexation
96 */
97 OptionalQuestionIndexation loadByQuestionId( int nQuestionId, Plugin plugin );
98
99 /**
100 * Load the data of all the optionalQuestionIndexation objects and returns them as a list
101 *
102 * @param plugin
103 * the Plugin
104 * @return The list which contains the data of all the optionalQuestionIndexation objects
105 */
106 List<OptionalQuestionIndexation> selectOptionalQuestionIndexationsList( Plugin plugin );
107
108 /**
109 * Load the data of all the optionalQuestionIndexation objects by form id and returns them as a list
110 *
111 * @param plugin
112 * the Plugin
113 * @return The list which contains the data of all the optionalQuestionIndexation objects
114 */
115 List<OptionalQuestionIndexation> selectOptionalQuestionIndexationsListByFormId( int nFormId, Plugin plugin );
116
117 /**
118 * Load the id of all the optionalQuestionIndexation objects and returns them as a list
119 *
120 * @param plugin
121 * the Plugin
122 * @return The list which contains the id of all the optionalQuestionIndexation objects
123 */
124 List<Integer> selectIdOptionalQuestionIndexationsList( Plugin plugin );
125
126 }