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