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