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