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.photo;
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.administration.user.Department;
30 import fr.ifremer.quadrige3.core.dao.referential.ObjectType;
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 * Liste les photos illustrant les passages, prélèvement, échantillon, taxon, .
39 * @see Photo
40 */
41 public interface PhotoDao
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 Photo}
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 Photo from the persistent store.
63 * @param photoId
64 * @return Photo
65 */
66 public Photo get(Integer photoId);
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 photoId 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 photoId);
83
84 /**
85 * Loads an instance of Photo from the persistent store.
86 * @param photoId
87 * @return Photo
88 */
89 public Photo load(Integer photoId);
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 photoId 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 photoId);
106
107 /**
108 * Loads all entities of type {@link Photo}.
109 *
110 * @return the loaded entities.
111 */
112 public Collection<Photo> 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 Photo and adds it to the persistent store.
160 * @param photo
161 * @return Photo
162 */
163 public Photo create(Photo photo);
164
165 /**
166 * <p>
167 * Does the same thing as {@link #create(Photo)} 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 photo
176 * @return Object
177 */
178 public Object create(int transform, Photo photo);
179
180 /**
181 * Creates a new instance of Photo and adds
182 * from the passed in <code>entities</code> collection
183 *
184 * @param entities the collection of Photo
185 * instances to create.
186 *
187 * @return the created instances.
188 */
189 public Collection<Photo> create(Collection<Photo> entities);
190
191 /**
192 * <p>
193 * Does the same thing as {@link #create(Photo)} 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<Photo> entities);
205
206 /**
207 * <p>
208 * Creates a new <code>Photo</code>
209 * instance from <strong>all</strong> attributes and adds it to
210 * the persistent store.
211 * </p>
212 * @param objectId Identifiant de l'objet photographié
213 * @param photoNm Libellé de la photo
214 * @param photoDirDc Description de la direction de la photo
215 * @param photoCm Commentaire associé à la photo
216 * @param photoLk Adresse du fichier photo, cette adresse est une adresse relative par rapport à une racine définie
217 dans l'environnement Quadrige. Cette adresse est renseignée par le système et n'est pas modifiable
218 par l'utilisateur.
219 * @param photoDt Date de prise de la photo optionnel
220 * @param photoValidDt Date de validation
221 * @param photoQualifDt Date de qualification de la photo
222 * @param photoQualifCm Commentaire sur la qualification de la photo
223 * @param updateDt Date de modification de l'objet, mise à jour par le système
224 * @param remoteId
225 * @return Photo
226 */
227 public Photo create(
228 Integer objectId,
229 String photoNm,
230 String photoDirDc,
231 String photoCm,
232 String photoLk,
233 Date photoDt,
234 Date photoValidDt,
235 Date photoQualifDt,
236 String photoQualifCm,
237 Timestamp updateDt,
238 Integer remoteId);
239
240 /**
241 * <p>
242 * Does the same thing as {@link #create(Integer, String, String, String, String, Date, Date, Date, String, Timestamp, Integer)} 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 objectId Identifiant de l'objet photographié
251 * @param photoNm Libellé de la photo
252 * @param photoDirDc Description de la direction de la photo
253 * @param photoCm Commentaire associé à la photo
254 * @param photoLk Adresse du fichier photo, cette adresse est une adresse relative par rapport à une racine définie
255 dans l'environnement Quadrige. Cette adresse est renseignée par le système et n'est pas modifiable
256 par l'utilisateur.
257 * @param photoDt Date de prise de la photo optionnel
258 * @param photoValidDt Date de validation
259 * @param photoQualifDt Date de qualification de la photo
260 * @param photoQualifCm Commentaire sur la qualification de la photo
261 * @param updateDt Date de modification de l'objet, mise à jour par le système
262 * @param remoteId
263 * @return Photo
264 */
265 public Object create(
266 int transform,
267 Integer objectId,
268 String photoNm,
269 String photoDirDc,
270 String photoCm,
271 String photoLk,
272 Date photoDt,
273 Date photoValidDt,
274 Date photoQualifDt,
275 String photoQualifCm,
276 Timestamp updateDt,
277 Integer remoteId);
278
279 /**
280 * <p>
281 * Creates a new <code>Photo</code>
282 * instance from only <strong>required</strong> properties (attributes
283 * and association ends) and adds it to the persistent store.
284 * </p>
285 * @param objectId
286 * @param objectType
287 * @param recorderDepartment
288 * @return Photo
289 */
290 public Photo create(
291 Integer objectId,
292 ObjectType objectType,
293 Department recorderDepartment);
294
295 /**
296 * <p>
297 * Does the same thing as {@link #create(Integer)} 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 objectId
306 * @param objectType
307 * @param recorderDepartment
308 * @return Object
309 */
310 public Object create(
311 int transform,
312 Integer objectId,
313 ObjectType objectType,
314 Department recorderDepartment);
315
316 /**
317 * Updates the <code>photo</code> instance in the persistent store.
318 * @param photo
319 */
320 public void update(Photo photo);
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<Photo> entities);
327
328 /**
329 * Removes the instance of Photo from the persistent store.
330 * @param photo
331 */
332 public void remove(Photo photo);
333
334 /**
335 * Removes the instance of Photo having the given
336 * <code>identifier</code> from the persistent store.
337 * @param photoId
338 */
339 public void remove(Integer photoId);
340
341 /**
342 * Removes all entities in the given <code>entities</code> collection.
343 * @param entities
344 */
345 public void remove(Collection<Photo> 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<Photo> 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.quadrige3.core.dao.data.photo.PhotoDao</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.quadrige3.core.dao.data.photo.PhotoDao}
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 Photo entity);
411
412 /**
413 * Transforms a collection of entities using the
414 * {@link #transformEntity(int,Photo)}
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.quadrige3.core.dao.data.photo.PhotoDao</code>
420 * @param entities the collection of entities to transform
421 * @see #transformEntity(int,Photo)
422 */
423 public void transformEntities(final int transform, final Collection<?> entities);
424
425 // spring-dao merge-point
426 }