1 // license-header java merge-point
2 //
3 // Attention: Generated code! Do not modify by hand!
4 // Generated by: SpringDao.vsl in andromda-spring-cartridge.
5 //
6 package fr.ifremer.quadrige3.core.dao.referential.pmfm;
7
8 /*-
9 * #%L
10 * Quadrige3 Core :: Client API
11 * %%
12 * Copyright (C) 2017 - 2024 Ifremer
13 * %%
14 * This program is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Affero General Public License as published by
16 * the Free Software Foundation, either version 3 of the License, or
17 * (at your option) any later version.
18 *
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * You should have received a copy of the GNU Affero General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 * #L%
27 */
28 import fr.ifremer.quadrige3.core.dao.Search;
29 import fr.ifremer.quadrige3.core.dao.referential.Status;
30 import java.sql.Timestamp;
31 import java.util.Collection;
32 import java.util.Date;
33 import java.util.Set;
34 import org.andromda.spring.PaginationResult;
35
36 /**
37 * Méthode utilisée pour mesurer un paramètre.
38 * @see Method
39 */
40 public interface MethodDao
41 {
42 /**
43 * This constant is used as a transformation flag; entities can be converted automatically into value objects
44 * or other types, different methods in a class implementing this interface support this feature: look for
45 * an <code>int</code> parameter called <code>transform</code>.
46 * <p>
47 * This specific flag denotes no transformation will occur.
48 */
49 public static final int TRANSFORM_NONE = 0;
50
51
52 /**
53 * Transforms the given results to a collection of {@link Method}
54 * instances (this is useful when the returned results contains a row of data and you want just entities only).
55 *
56 * @param results the query results.
57 */
58 public void toEntities(final Collection<?> results);
59
60 /**
61 * Gets an instance of Method from the persistent store.
62 * @param methodId
63 * @return Method
64 */
65 public Method get(Integer methodId);
66
67 /**
68 * <p>
69 * Does the same thing as {@link #get(Integer)} with an
70 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
71 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
72 * defined in this class then the result <strong>WILL BE</strong> passed through an operation which can
73 * optionally transform the entity (into a value object for example). By default, transformation does
74 * not occur.
75 * </p>
76 *
77 * @param transform flag to determine transformation type.
78 * @param methodId the identifier of the entity to get.
79 * @return either the entity or the object transformed from the entity.
80 */
81 public Object get(int transform, Integer methodId);
82
83 /**
84 * Loads an instance of Method from the persistent store.
85 * @param methodId
86 * @return Method
87 */
88 public Method load(Integer methodId);
89
90 /**
91 * <p>
92 * Does the same thing as {@link #load(Integer)} with an
93 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
94 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
95 * defined in this class then the result <strong>WILL BE</strong> passed through an operation which can
96 * optionally transform the entity (into a value object for example). By default, transformation does
97 * not occur.
98 * </p>
99 *
100 * @param transform flag to determine transformation type.
101 * @param methodId the identifier of the entity to load.
102 * @return either the entity or the object transformed from the entity.
103 */
104 public Object load(int transform, Integer methodId);
105
106 /**
107 * Loads all entities of type {@link Method}.
108 *
109 * @return the loaded entities.
110 */
111 public Collection<Method> loadAll();
112
113 /**
114 * <p>
115 * Does the same thing as {@link #loadAll()} with an
116 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
117 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
118 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
119 * transform the entity (into a value object for example). By default, transformation does
120 * not occur.
121 * </p>
122 *
123 * @param transform the flag indicating what transformation to use.
124 * @return the loaded entities.
125 */
126 public Collection<?> loadAll(final int transform);
127
128 /**
129 * <p>
130 * Does the same thing as {@link #loadAll()} with an
131 * additional two arguments called <code>pageNumber</code> and <code>pageSize</code>. The <code>pageNumber</code>
132 * argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the
133 * page retrieved.
134 * </p>
135 *
136 * @param pageNumber the page number to retrieve when paging results.
137 * @param pageSize the size of the page to retrieve when paging results.
138 * @return the loaded entities.
139 */
140 public Collection<?> loadAll(final int pageNumber, final int pageSize);
141
142 /**
143 * <p>
144 * Does the same thing as {@link #loadAll(int)} with an
145 * additional two arguments called <code>pageNumber</code> and <code>pageSize</code>. The <code>pageNumber</code>
146 * argument allows you to specify the page number when you are paging the results and the pageSize allows you to specify the size of the
147 * page retrieved.
148 * </p>
149 *
150 * @param transform the flag indicating what transformation to use.
151 * @param pageNumber the page number to retrieve when paging results.
152 * @param pageSize the size of the page to retrieve when paging results.
153 * @return the loaded entities.
154 */
155 public Collection<?> loadAll(final int transform, final int pageNumber, final int pageSize);
156
157 /**
158 * Creates an instance of Method and adds it to the persistent store.
159 * @param method
160 * @return Method
161 */
162 public Method create(Method method);
163
164 /**
165 * <p>
166 * Does the same thing as {@link #create(Method)} with an
167 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
168 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
169 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
170 * transform the entity (into a value object for example). By default, transformation does
171 * not occur.
172 * </p>
173 * @param transform
174 * @param method
175 * @return Object
176 */
177 public Object create(int transform, Method method);
178
179 /**
180 * Creates a new instance of Method and adds
181 * from the passed in <code>entities</code> collection
182 *
183 * @param entities the collection of Method
184 * instances to create.
185 *
186 * @return the created instances.
187 */
188 public Collection<Method> create(Collection<Method> entities);
189
190 /**
191 * <p>
192 * Does the same thing as {@link #create(Method)} with an
193 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
194 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
195 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
196 * transform the entities (into value objects for example). By default, transformation does
197 * not occur.
198 * </p>
199 * @param transform
200 * @param entities
201 * @return Collection
202 */
203 public Collection<?> create(int transform, Collection<Method> entities);
204
205 /**
206 * <p>
207 * Creates a new <code>Method</code>
208 * instance from <strong>all</strong> attributes and adds it to
209 * the persistent store.
210 * </p>
211 * @param methodNm Libellé de la méthode
212 * @param methodDc Description de la méthode
213 * @param methodCondition Description du conditionnement
214 * @param methodPrepar Description des conditions de préparation
215 * @param methodConserv Description des conditions de conservation
216 * @param methodRef Référence à l'origine de la méthode.
217 Par exemple : "Bradford M., 1976. A rapid method for quantification of protein utilizing the
218 principle of dye binding. Anal. Biochem. 72 : 248-264" ou "Circulaire 1988 Mer/Agriculture"
219 * @param methodRk Numéro de la méthode pour pouvoir "chainer" les méthodes
220 * @param methodHandbookPathNm Adresse du fichier de la fiche méthode
221 * @param methodCreationDt Date de création
222 * @param updateDt Date de mise à jour
223 * @param methodCm
224 * @return Method
225 */
226 public Method create(
227 String methodNm,
228 String methodDc,
229 String methodCondition,
230 String methodPrepar,
231 String methodConserv,
232 String methodRef,
233 String methodRk,
234 String methodHandbookPathNm,
235 Date methodCreationDt,
236 Timestamp updateDt,
237 String methodCm);
238
239 /**
240 * <p>
241 * Does the same thing as {@link #create(String, String, String, String, String, String, String, String, Date, Timestamp, String)} with an
242 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
243 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
244 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
245 * transform the entity (into a value object for example). By default, transformation does
246 * not occur.
247 * </p>
248 * @param transform
249 * @param methodNm Libellé de la méthode
250 * @param methodDc Description de la méthode
251 * @param methodCondition Description du conditionnement
252 * @param methodPrepar Description des conditions de préparation
253 * @param methodConserv Description des conditions de conservation
254 * @param methodRef Référence à l'origine de la méthode.
255 Par exemple : "Bradford M., 1976. A rapid method for quantification of protein utilizing the
256 principle of dye binding. Anal. Biochem. 72 : 248-264" ou "Circulaire 1988 Mer/Agriculture"
257 * @param methodRk Numéro de la méthode pour pouvoir "chainer" les méthodes
258 * @param methodHandbookPathNm Adresse du fichier de la fiche méthode
259 * @param methodCreationDt Date de création
260 * @param updateDt Date de mise à jour
261 * @param methodCm
262 * @return Method
263 */
264 public Object create(
265 int transform,
266 String methodNm,
267 String methodDc,
268 String methodCondition,
269 String methodPrepar,
270 String methodConserv,
271 String methodRef,
272 String methodRk,
273 String methodHandbookPathNm,
274 Date methodCreationDt,
275 Timestamp updateDt,
276 String methodCm);
277
278 /**
279 * <p>
280 * Creates a new <code>Method</code>
281 * instance from only <strong>required</strong> properties (attributes
282 * and association ends) and adds it to the persistent store.
283 * </p>
284 * @param methodNm
285 * @param methodRk
286 * @param status
287 * @return Method
288 */
289 public Method create(
290 String methodNm,
291 String methodRk,
292 Status status);
293
294 /**
295 * <p>
296 * Does the same thing as {@link #create(String, String)} with an
297 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
298 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
299 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
300 * transform the entity (into a value object for example). By default, transformation does
301 * not occur.
302 * </p>
303 * @param transform flag to determine transformation type.
304 * @param methodNm
305 * @param methodRk
306 * @param status
307 * @return Object
308 */
309 public Object create(
310 int transform,
311 String methodNm,
312 String methodRk,
313 Status status);
314
315 /**
316 * Updates the <code>method</code> instance in the persistent store.
317 * @param method
318 */
319 public void update(Method method);
320
321 /**
322 * Updates all instances in the <code>entities</code> collection in the persistent store.
323 * @param entities
324 */
325 public void update(Collection<Method> entities);
326
327 /**
328 * Removes the instance of Method from the persistent store.
329 * @param method
330 */
331 public void remove(Method method);
332
333 /**
334 * Removes the instance of Method having the given
335 * <code>identifier</code> from the persistent store.
336 * @param methodId
337 */
338 public void remove(Integer methodId);
339
340 /**
341 * Removes all entities in the given <code>entities</code> collection.
342 * @param entities
343 */
344 public void remove(Collection<Method> entities);
345
346
347 /**
348 * Does the same thing as {@link #search(int, Search)} but with an
349 * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
350 * limit your data to a specified page number and size.
351 *
352 * @param transform the transformation flag.
353 * @param pageNumber the page number in the data to retrieve
354 * @param pageSize the size of the page to retrieve.
355 * @param search the search object which provides the search parameters and pagination specification.
356 * @return any found results from the search wrapped in a {@link PaginationResult} instance.
357 */
358 public PaginationResult search(final int transform, final int pageNumber, final int pageSize, final Search search);
359
360 /**
361 * Does the same thing as {@link #search(Search)} but with an
362 * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
363 * limit your data to a specified page number and size.
364 *
365 * @param pageNumber the page number in the data to retrieve
366 * @param pageSize the size of the page to retrieve.
367 * @param search the search object which provides the search parameters and pagination specification.
368 * @return any found results from the search wrapped in a {@link PaginationResult} instance.
369 */
370 public PaginationResult search(final int pageNumber, final int pageSize, final Search search);
371
372 /**
373 * Does the same thing as {@link #search(Search)} but with an
374 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
375 * finder results will <strong>NOT</strong> be transformed during retrieval.
376 * If this flag is any of the other constants defined here
377 * then results <strong>WILL BE</strong> passed through an operation which can optionally
378 * transform the entities (into value objects for example). By default, transformation does
379 * not occur.
380 *
381 * @param transform the transformation flag.
382 * @param search the search object which provides the search parameters and pagination specification.
383 * @return any found results from the search.
384 */
385 public Set<?> search(final int transform, final Search search);
386
387 /**
388 * Performs a search using the parameters specified in the given <code>search</code> object.
389 *
390 * @param search the search object which provides the search parameters and pagination specification.
391 * @return any found results from the search.
392 */
393 public Set<Method> search(final Search search);
394
395 /**
396 * Allows transformation of entities into value objects
397 * (or something else for that matter), when the <code>transform</code>
398 * flag is set to one of the constants defined in <code>fr.ifremer.quadrige3.core.dao.referential.pmfm.MethodDao</code>, please note
399 * that the {@link #TRANSFORM_NONE} constant denotes no transformation, so the entity itself
400 * will be returned.
401 *
402 * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
403 *
404 * @param transform one of the constants declared in {@link fr.ifremer.quadrige3.core.dao.referential.pmfm.MethodDao}
405 * @param entity an entity that was found
406 * @return the transformed entity (i.e. new value object, etc)
407 * @see #transformEntities(int,Collection)
408 */
409 public Object transformEntity(final int transform, final Method entity);
410
411 /**
412 * Transforms a collection of entities using the
413 * {@link #transformEntity(int,Method)}
414 * method. This method does not instantiate a new collection.
415 * <p>
416 * This method is to be used internally only.
417 *
418 * @param transform one of the constants declared in <code>fr.ifremer.quadrige3.core.dao.referential.pmfm.MethodDao</code>
419 * @param entities the collection of entities to transform
420 * @see #transformEntity(int,Method)
421 */
422 public void transformEntities(final int transform, final Collection<?> entities);
423
424 // spring-dao merge-point
425 }