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.genericattributes.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37
38 import java.util.List;
39
40 /**
41 * IFieldDAO Interface
42 */
43 public interface IFieldDAO
44 {
45 /**
46 * Insert a new record in the table.
47 *
48 * @param field
49 * instance of the Field object to insert
50 * @param plugin
51 * the plugin
52 * @return the new field create
53 */
54 int insert( Field field, Plugin plugin );
55
56 /**
57 * Update the field in the table
58 *
59 * @param field
60 * instance of the Field object to update
61 * @param plugin
62 * the plugin
63 */
64 void store( Field field, Plugin plugin );
65
66 /**
67 * Delete a record from the table
68 *
69 * @param nIdField
70 * The identifier of the field
71 * @param plugin
72 * the plugin
73 */
74 void delete( int nIdField, Plugin plugin );
75
76 // /////////////////////////////////////////////////////////////////////////
77 // Finders
78
79 /**
80 * Load the data of the Field from the table
81 *
82 * @param nIdField
83 * The identifier of the field
84 * @param plugin
85 * the plugin
86 * @return the instance of the Field
87 */
88 Field load( int nIdField, Plugin plugin );
89
90 /**
91 * Load the data of all the field of the entry and returns them in a list
92 *
93 * @param idEntry
94 * the id of the entry
95 * @param plugin
96 * the plugin
97 * @return the list of field
98 */
99 List<Field> selectFieldListByIdEntry( int idEntry, Plugin plugin );
100
101 /**
102 * Delete an association between field and a regular expression
103 *
104 * @param nIdField
105 * The identifier of the field
106 * @param nIdExpression
107 * The identifier of the regular expression
108 * @param plugin
109 * the plugin
110 */
111 void deleteVerifyBy( int nIdField, int nIdExpression, Plugin plugin );
112
113 /**
114 * insert an association between field and a regular expression
115 *
116 * @param nIdField
117 * The identifier of the field
118 * @param nIdExpression
119 * The identifier of the regular expression
120 * @param plugin
121 * the plugin
122 */
123 void insertVerifyBy( int nIdField, int nIdExpression, Plugin plugin );
124
125 /**
126 * Load the key of all the regularExpression associate to the field and returns them in a list
127 *
128 * @param nIdField
129 * the id of the field
130 * @param plugin
131 * the plugin
132 * @return the list of regular expression key
133 */
134 List<Integer> selectListRegularExpressionKeyByIdField( int nIdField, Plugin plugin );
135
136 /**
137 * verify if the regular expression is use
138 *
139 * @param nIdExpression
140 * The identifier of the regular expression
141 * @param plugin
142 * the plugin
143 * @return true if the regular expression is use
144 */
145 boolean isRegularExpressionIsUse( int nIdExpression, Plugin plugin );
146
147 /**
148 * Load all the fields by list of id_enrty.
149 *
150 * @param idList
151 * @param plugin
152 * @return
153 */
154 List<Field> loadMultipleByEntryIdList( List<Integer> idList, Plugin plugin );
155
156 /**
157 * Load all Fields by code
158 *
159 * @param code
160 * @param plugin
161 * @return
162 */
163 List<Field> loadByCode( String code, Plugin plugin );
164 }