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.eunis;
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 des versions des différentes typologies EUNIS.
37 * @see EunisVersion
38 */
39 public interface EunisVersionDao
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 EunisVersion}
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 EunisVersion from the persistent store.
61 * @param eunisVersionId
62 * @return EunisVersion
63 */
64 public EunisVersion get(Integer eunisVersionId);
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 eunisVersionId 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 eunisVersionId);
81
82 /**
83 * Loads an instance of EunisVersion from the persistent store.
84 * @param eunisVersionId
85 * @return EunisVersion
86 */
87 public EunisVersion load(Integer eunisVersionId);
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 eunisVersionId 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 eunisVersionId);
104
105 /**
106 * Loads all entities of type {@link EunisVersion}.
107 *
108 * @return the loaded entities.
109 */
110 public Collection<EunisVersion> 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 EunisVersion and adds it to the persistent store.
158 * @param eunisVersion
159 * @return EunisVersion
160 */
161 public EunisVersion create(EunisVersion eunisVersion);
162
163 /**
164 * <p>
165 * Does the same thing as {@link #create(EunisVersion)} 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 eunisVersion
174 * @return Object
175 */
176 public Object create(int transform, EunisVersion eunisVersion);
177
178 /**
179 * Creates a new instance of EunisVersion and adds
180 * from the passed in <code>entities</code> collection
181 *
182 * @param entities the collection of EunisVersion
183 * instances to create.
184 *
185 * @return the created instances.
186 */
187 public Collection<EunisVersion> create(Collection<EunisVersion> entities);
188
189 /**
190 * <p>
191 * Does the same thing as {@link #create(EunisVersion)} 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<EunisVersion> entities);
203
204 /**
205 * <p>
206 * Creates a new <code>EunisVersion</code>
207 * instance from <strong>all</strong> attributes and adds it to
208 * the persistent store.
209 * </p>
210 * @param eunisVersionDt Date de réception de la version
211 * @param eunisVersionNm Libellé de la version
212 * @param eunisVersionCm Description de la version
213 * @param eunisVersionIsCurrent Indique s'il s'agit de la dernière version ou non
214 * @param updateDt Date de modification de l'objet, mise à jour par le système
215 * @return EunisVersion
216 */
217 public EunisVersion create(
218 Date eunisVersionDt,
219 String eunisVersionNm,
220 String eunisVersionCm,
221 String eunisVersionIsCurrent,
222 Timestamp updateDt);
223
224 /**
225 * <p>
226 * Does the same thing as {@link #create(Date, String, String, String, Timestamp)} with an
227 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
228 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
229 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
230 * transform the entity (into a value object for example). By default, transformation does
231 * not occur.
232 * </p>
233 * @param transform
234 * @param eunisVersionDt Date de réception de la version
235 * @param eunisVersionNm Libellé de la version
236 * @param eunisVersionCm Description de la version
237 * @param eunisVersionIsCurrent Indique s'il s'agit de la dernière version ou non
238 * @param updateDt Date de modification de l'objet, mise à jour par le système
239 * @return EunisVersion
240 */
241 public Object create(
242 int transform,
243 Date eunisVersionDt,
244 String eunisVersionNm,
245 String eunisVersionCm,
246 String eunisVersionIsCurrent,
247 Timestamp updateDt);
248
249
250 /**
251 * Updates the <code>eunisVersion</code> instance in the persistent store.
252 * @param eunisVersion
253 */
254 public void update(EunisVersion eunisVersion);
255
256 /**
257 * Updates all instances in the <code>entities</code> collection in the persistent store.
258 * @param entities
259 */
260 public void update(Collection<EunisVersion> entities);
261
262 /**
263 * Removes the instance of EunisVersion from the persistent store.
264 * @param eunisVersion
265 */
266 public void remove(EunisVersion eunisVersion);
267
268 /**
269 * Removes the instance of EunisVersion having the given
270 * <code>identifier</code> from the persistent store.
271 * @param eunisVersionId
272 */
273 public void remove(Integer eunisVersionId);
274
275 /**
276 * Removes all entities in the given <code>entities</code> collection.
277 * @param entities
278 */
279 public void remove(Collection<EunisVersion> entities);
280
281
282 /**
283 * Does the same thing as {@link #search(int, Search)} but with an
284 * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
285 * limit your data to a specified page number and size.
286 *
287 * @param transform the transformation flag.
288 * @param pageNumber the page number in the data to retrieve
289 * @param pageSize the size of the page to retrieve.
290 * @param search the search object which provides the search parameters and pagination specification.
291 * @return any found results from the search wrapped in a {@link PaginationResult} instance.
292 */
293 public PaginationResult search(final int transform, final int pageNumber, final int pageSize, final Search search);
294
295 /**
296 * Does the same thing as {@link #search(Search)} but with an
297 * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
298 * limit your data to a specified page number and size.
299 *
300 * @param pageNumber the page number in the data to retrieve
301 * @param pageSize the size of the page to retrieve.
302 * @param search the search object which provides the search parameters and pagination specification.
303 * @return any found results from the search wrapped in a {@link PaginationResult} instance.
304 */
305 public PaginationResult search(final int pageNumber, final int pageSize, final Search search);
306
307 /**
308 * Does the same thing as {@link #search(Search)} but with an
309 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
310 * finder results will <strong>NOT</strong> be transformed during retrieval.
311 * If this flag is any of the other constants defined here
312 * then results <strong>WILL BE</strong> passed through an operation which can optionally
313 * transform the entities (into value objects for example). By default, transformation does
314 * not occur.
315 *
316 * @param transform the transformation flag.
317 * @param search the search object which provides the search parameters and pagination specification.
318 * @return any found results from the search.
319 */
320 public Set<?> search(final int transform, final Search search);
321
322 /**
323 * Performs a search using the parameters specified in the given <code>search</code> object.
324 *
325 * @param search the search object which provides the search parameters and pagination specification.
326 * @return any found results from the search.
327 */
328 public Set<EunisVersion> search(final Search search);
329
330 /**
331 * Allows transformation of entities into value objects
332 * (or something else for that matter), when the <code>transform</code>
333 * flag is set to one of the constants defined in <code>fr.ifremer.quadrige3.core.dao.referential.eunis.EunisVersionDao</code>, please note
334 * that the {@link #TRANSFORM_NONE} constant denotes no transformation, so the entity itself
335 * will be returned.
336 *
337 * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
338 *
339 * @param transform one of the constants declared in {@link fr.ifremer.quadrige3.core.dao.referential.eunis.EunisVersionDao}
340 * @param entity an entity that was found
341 * @return the transformed entity (i.e. new value object, etc)
342 * @see #transformEntities(int,Collection)
343 */
344 public Object transformEntity(final int transform, final EunisVersion entity);
345
346 /**
347 * Transforms a collection of entities using the
348 * {@link #transformEntity(int,EunisVersion)}
349 * method. This method does not instantiate a new collection.
350 * <p>
351 * This method is to be used internally only.
352 *
353 * @param transform one of the constants declared in <code>fr.ifremer.quadrige3.core.dao.referential.eunis.EunisVersionDao</code>
354 * @param entities the collection of entities to transform
355 * @see #transformEntity(int,EunisVersion)
356 */
357 public void transformEntities(final int transform, final Collection<?> entities);
358
359 // spring-dao merge-point
360 }