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