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.data.measurement;
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.ObjectType;
30 import fr.ifremer.quadrige3.core.dao.referential.QualityFlag;
31 import fr.ifremer.quadrige3.core.dao.referential.pmfm.Pmfm;
32 import java.sql.Timestamp;
33 import java.util.Collection;
34 import java.util.Date;
35 import java.util.Set;
36 import org.andromda.spring.PaginationResult;
37
38 /**
39 * Résultat de mesure faisant uniquement référence à un fichier.
40 * @see MeasurementFile
41 */
42 public interface MeasurementFileDao
43 {
44 /**
45 * This constant is used as a transformation flag; entities can be converted automatically into value objects
46 * or other types, different methods in a class implementing this interface support this feature: look for
47 * an <code>int</code> parameter called <code>transform</code>.
48 * <p>
49 * This specific flag denotes no transformation will occur.
50 */
51 public static final int TRANSFORM_NONE = 0;
52
53
54 /**
55 * Transforms the given results to a collection of {@link MeasurementFile}
56 * instances (this is useful when the returned results contains a row of data and you want just entities only).
57 *
58 * @param results the query results.
59 */
60 public void toEntities(final Collection<?> results);
61
62 /**
63 * Gets an instance of MeasurementFile from the persistent store.
64 * @param measFileId
65 * @return MeasurementFile
66 */
67 public MeasurementFile get(Integer measFileId);
68
69 /**
70 * <p>
71 * Does the same thing as {@link #get(Integer)} with an
72 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
73 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
74 * defined in this class then the result <strong>WILL BE</strong> passed through an operation which can
75 * optionally transform the entity (into a value object for example). By default, transformation does
76 * not occur.
77 * </p>
78 *
79 * @param transform flag to determine transformation type.
80 * @param measFileId the identifier of the entity to get.
81 * @return either the entity or the object transformed from the entity.
82 */
83 public Object get(int transform, Integer measFileId);
84
85 /**
86 * Loads an instance of MeasurementFile from the persistent store.
87 * @param measFileId
88 * @return MeasurementFile
89 */
90 public MeasurementFile load(Integer measFileId);
91
92 /**
93 * <p>
94 * Does the same thing as {@link #load(Integer)} with an
95 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
96 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
97 * defined in this class then the result <strong>WILL BE</strong> passed through an operation which can
98 * optionally transform the entity (into a value object for example). By default, transformation does
99 * not occur.
100 * </p>
101 *
102 * @param transform flag to determine transformation type.
103 * @param measFileId the identifier of the entity to load.
104 * @return either the entity or the object transformed from the entity.
105 */
106 public Object load(int transform, Integer measFileId);
107
108 /**
109 * Loads all entities of type {@link MeasurementFile}.
110 *
111 * @return the loaded entities.
112 */
113 public Collection<MeasurementFile> loadAll();
114
115 /**
116 * <p>
117 * Does the same thing as {@link #loadAll()} with an
118 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
119 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
120 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
121 * transform the entity (into a value object for example). By default, transformation does
122 * not occur.
123 * </p>
124 *
125 * @param transform the flag indicating what transformation to use.
126 * @return the loaded entities.
127 */
128 public Collection<?> loadAll(final int transform);
129
130 /**
131 * <p>
132 * Does the same thing as {@link #loadAll()} with an
133 * additional two arguments called <code>pageNumber</code> and <code>pageSize</code>. The <code>pageNumber</code>
134 * 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
135 * page retrieved.
136 * </p>
137 *
138 * @param pageNumber the page number to retrieve when paging results.
139 * @param pageSize the size of the page to retrieve when paging results.
140 * @return the loaded entities.
141 */
142 public Collection<?> loadAll(final int pageNumber, final int pageSize);
143
144 /**
145 * <p>
146 * Does the same thing as {@link #loadAll(int)} with an
147 * additional two arguments called <code>pageNumber</code> and <code>pageSize</code>. The <code>pageNumber</code>
148 * 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
149 * page retrieved.
150 * </p>
151 *
152 * @param transform the flag indicating what transformation to use.
153 * @param pageNumber the page number to retrieve when paging results.
154 * @param pageSize the size of the page to retrieve when paging results.
155 * @return the loaded entities.
156 */
157 public Collection<?> loadAll(final int transform, final int pageNumber, final int pageSize);
158
159 /**
160 * Creates an instance of MeasurementFile and adds it to the persistent store.
161 * @param measurementFile
162 * @return MeasurementFile
163 */
164 public MeasurementFile create(MeasurementFile measurementFile);
165
166 /**
167 * <p>
168 * Does the same thing as {@link #create(MeasurementFile)} with an
169 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
170 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
171 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
172 * transform the entity (into a value object for example). By default, transformation does
173 * not occur.
174 * </p>
175 * @param transform
176 * @param measurementFile
177 * @return Object
178 */
179 public Object create(int transform, MeasurementFile measurementFile);
180
181 /**
182 * Creates a new instance of MeasurementFile and adds
183 * from the passed in <code>entities</code> collection
184 *
185 * @param entities the collection of MeasurementFile
186 * instances to create.
187 *
188 * @return the created instances.
189 */
190 public Collection<MeasurementFile> create(Collection<MeasurementFile> entities);
191
192 /**
193 * <p>
194 * Does the same thing as {@link #create(MeasurementFile)} with an
195 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
196 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
197 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
198 * transform the entities (into value objects for example). By default, transformation does
199 * not occur.
200 * </p>
201 * @param transform
202 * @param entities
203 * @return Collection
204 */
205 public Collection<?> create(int transform, Collection<MeasurementFile> entities);
206
207 /**
208 * <p>
209 * Creates a new <code>MeasurementFile</code>
210 * instance from <strong>all</strong> attributes and adds it to
211 * the persistent store.
212 * </p>
213 * @param objectId Identifiant interne de donnnée in situ de référence (passage, prélèvement, prélèvement)
214 * @param measFilePathNm Adresse du fichier de mesure stocké sur le serveur Q2.
215 * @param measFileNm Libellé du fichier de mesure
216 * @param measFileCm Commentaire sur le fichier de mesure
217 * @param measFileValidDt Date de validation
218 * @param measFileControlDt Date de contrôle
219 * @param measFileQualifDt Date de la qualification du résultat
220 * @param measFileQualifCm Commentaire sur la qualification du résultat
221 Un commentaire de qualification est obligatoire si la mesure est douteuse ou mauvaise.
222 * @param updateDt Date de modification de l'objet, mise à jour par le système
223 * @param remoteId
224 * @return MeasurementFile
225 */
226 public MeasurementFile create(
227 Integer objectId,
228 String measFilePathNm,
229 String measFileNm,
230 String measFileCm,
231 Date measFileValidDt,
232 Date measFileControlDt,
233 Date measFileQualifDt,
234 String measFileQualifCm,
235 Timestamp updateDt,
236 Integer remoteId);
237
238 /**
239 * <p>
240 * Does the same thing as {@link #create(Integer, String, String, String, Date, Date, Date, String, Timestamp, Integer)} 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 objectId Identifiant interne de donnnée in situ de référence (passage, prélèvement, prélèvement)
249 * @param measFilePathNm Adresse du fichier de mesure stocké sur le serveur Q2.
250 * @param measFileNm Libellé du fichier de mesure
251 * @param measFileCm Commentaire sur le fichier de mesure
252 * @param measFileValidDt Date de validation
253 * @param measFileControlDt Date de contrôle
254 * @param measFileQualifDt Date de la qualification du résultat
255 * @param measFileQualifCm Commentaire sur la qualification du résultat
256 Un commentaire de qualification est obligatoire si la mesure est douteuse ou mauvaise.
257 * @param updateDt Date de modification de l'objet, mise à jour par le système
258 * @param remoteId
259 * @return MeasurementFile
260 */
261 public Object create(
262 int transform,
263 Integer objectId,
264 String measFilePathNm,
265 String measFileNm,
266 String measFileCm,
267 Date measFileValidDt,
268 Date measFileControlDt,
269 Date measFileQualifDt,
270 String measFileQualifCm,
271 Timestamp updateDt,
272 Integer remoteId);
273
274 /**
275 * <p>
276 * Creates a new <code>MeasurementFile</code>
277 * instance from only <strong>required</strong> properties (attributes
278 * and association ends) and adds it to the persistent store.
279 * </p>
280 * @param measFilePathNm
281 * @param objectId
282 * @param objectType
283 * @param pmfm
284 * @param qualityFlag
285 * @return MeasurementFile
286 */
287 public MeasurementFile create(
288 String measFilePathNm,
289 Integer objectId,
290 ObjectType objectType,
291 Pmfm pmfm,
292 QualityFlag qualityFlag);
293
294 /**
295 * <p>
296 * Does the same thing as {@link #create(Integer, 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 measFilePathNm
305 * @param objectId
306 * @param objectType
307 * @param pmfm
308 * @param qualityFlag
309 * @return Object
310 */
311 public Object create(
312 int transform,
313 String measFilePathNm,
314 Integer objectId,
315 ObjectType objectType,
316 Pmfm pmfm,
317 QualityFlag qualityFlag);
318
319 /**
320 * Updates the <code>measurementFile</code> instance in the persistent store.
321 * @param measurementFile
322 */
323 public void update(MeasurementFile measurementFile);
324
325 /**
326 * Updates all instances in the <code>entities</code> collection in the persistent store.
327 * @param entities
328 */
329 public void update(Collection<MeasurementFile> entities);
330
331 /**
332 * Removes the instance of MeasurementFile from the persistent store.
333 * @param measurementFile
334 */
335 public void remove(MeasurementFile measurementFile);
336
337 /**
338 * Removes the instance of MeasurementFile having the given
339 * <code>identifier</code> from the persistent store.
340 * @param measFileId
341 */
342 public void remove(Integer measFileId);
343
344 /**
345 * Removes all entities in the given <code>entities</code> collection.
346 * @param entities
347 */
348 public void remove(Collection<MeasurementFile> entities);
349
350
351 /**
352 * Does the same thing as {@link #search(int, Search)} but with an
353 * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
354 * limit your data to a specified page number and size.
355 *
356 * @param transform the transformation flag.
357 * @param pageNumber the page number in the data to retrieve
358 * @param pageSize the size of the page to retrieve.
359 * @param search the search object which provides the search parameters and pagination specification.
360 * @return any found results from the search wrapped in a {@link PaginationResult} instance.
361 */
362 public PaginationResult search(final int transform, final int pageNumber, final int pageSize, final Search search);
363
364 /**
365 * Does the same thing as {@link #search(Search)} but with an
366 * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
367 * limit your data to a specified page number and size.
368 *
369 * @param pageNumber the page number in the data to retrieve
370 * @param pageSize the size of the page to retrieve.
371 * @param search the search object which provides the search parameters and pagination specification.
372 * @return any found results from the search wrapped in a {@link PaginationResult} instance.
373 */
374 public PaginationResult search(final int pageNumber, final int pageSize, final Search search);
375
376 /**
377 * Does the same thing as {@link #search(Search)} but with an
378 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
379 * finder results will <strong>NOT</strong> be transformed during retrieval.
380 * If this flag is any of the other constants defined here
381 * then results <strong>WILL BE</strong> passed through an operation which can optionally
382 * transform the entities (into value objects for example). By default, transformation does
383 * not occur.
384 *
385 * @param transform the transformation flag.
386 * @param search the search object which provides the search parameters and pagination specification.
387 * @return any found results from the search.
388 */
389 public Set<?> search(final int transform, final Search search);
390
391 /**
392 * Performs a search using the parameters specified in the given <code>search</code> object.
393 *
394 * @param search the search object which provides the search parameters and pagination specification.
395 * @return any found results from the search.
396 */
397 public Set<MeasurementFile> search(final Search search);
398
399 /**
400 * Allows transformation of entities into value objects
401 * (or something else for that matter), when the <code>transform</code>
402 * flag is set to one of the constants defined in <code>fr.ifremer.quadrige3.core.dao.data.measurement.MeasurementFileDao</code>, please note
403 * that the {@link #TRANSFORM_NONE} constant denotes no transformation, so the entity itself
404 * will be returned.
405 *
406 * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
407 *
408 * @param transform one of the constants declared in {@link fr.ifremer.quadrige3.core.dao.data.measurement.MeasurementFileDao}
409 * @param entity an entity that was found
410 * @return the transformed entity (i.e. new value object, etc)
411 * @see #transformEntities(int,Collection)
412 */
413 public Object transformEntity(final int transform, final MeasurementFile entity);
414
415 /**
416 * Transforms a collection of entities using the
417 * {@link #transformEntity(int,MeasurementFile)}
418 * method. This method does not instantiate a new collection.
419 * <p>
420 * This method is to be used internally only.
421 *
422 * @param transform one of the constants declared in <code>fr.ifremer.quadrige3.core.dao.data.measurement.MeasurementFileDao</code>
423 * @param entities the collection of entities to transform
424 * @see #transformEntity(int,MeasurementFile)
425 */
426 public void transformEntities(final int transform, final Collection<?> entities);
427
428 // spring-dao merge-point
429 }