View Javadoc
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.versionning;
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   * Historiqque des versions du système.
37   * Chaque mise à jour du schéma entraine une insertion dans cette table.
38   * @see SystemVersion
39   */
40  public interface SystemVersionDao
41  {
42      /**
43       * This constant is used as a transformation flag; entities can be converted automatically into value objects
44       * or other types, different methods in a class implementing this interface support this feature: look for
45       * an <code>int</code> parameter called <code>transform</code>.
46       * <p>
47       * This specific flag denotes no transformation will occur.
48       */
49      public static final int TRANSFORM_NONE = 0;
50  
51  
52      /**
53       * Transforms the given results to a collection of {@link SystemVersion}
54       * instances (this is useful when the returned results contains a row of data and you want just entities only).
55       *
56       * @param results the query results.
57       */
58      public void toEntities(final Collection<?> results);
59  
60      /**
61       * Gets an instance of SystemVersion from the persistent store.
62       * @param systemVersionId
63       * @return SystemVersion
64       */
65      public SystemVersion get(Integer systemVersionId);
66  
67      /**
68       * <p>
69       * Does the same thing as {@link #get(Integer)} with an
70       * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
71       * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
72       * defined in this class then the result <strong>WILL BE</strong> passed through an operation which can
73       * optionally transform the entity (into a value object for example). By default, transformation does
74       * not occur.
75       * </p>
76       *
77       * @param transform flag to determine transformation type.
78       * @param systemVersionId the identifier of the entity to get.
79       * @return either the entity or the object transformed from the entity.
80       */
81      public Object get(int transform, Integer systemVersionId);
82  
83      /**
84       * Loads an instance of SystemVersion from the persistent store.
85       * @param systemVersionId
86       * @return SystemVersion
87       */
88      public SystemVersion load(Integer systemVersionId);
89  
90      /**
91       * <p>
92       * Does the same thing as {@link #load(Integer)} with an
93       * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
94       * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
95       * defined in this class then the result <strong>WILL BE</strong> passed through an operation which can
96       * optionally transform the entity (into a value object for example). By default, transformation does
97       * not occur.
98       * </p>
99       *
100      * @param transform flag to determine transformation type.
101      * @param systemVersionId the identifier of the entity to load.
102      * @return either the entity or the object transformed from the entity.
103      */
104     public Object load(int transform, Integer systemVersionId);
105 
106     /**
107      * Loads all entities of type {@link SystemVersion}.
108      *
109      * @return the loaded entities.
110      */
111     public Collection<SystemVersion> loadAll();
112 
113     /**
114      * <p>
115      * Does the same thing as {@link #loadAll()} with an
116      * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
117      * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
118      * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
119      * transform the entity (into a value object for example). By default, transformation does
120      * not occur.
121      * </p>
122      *
123      * @param transform the flag indicating what transformation to use.
124      * @return the loaded entities.
125      */
126     public Collection<?> loadAll(final int transform);
127 
128     /**
129      * <p>
130      * Does the same thing as {@link #loadAll()} with an
131      * additional two arguments called <code>pageNumber</code> and <code>pageSize</code>. The <code>pageNumber</code>
132      * 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
133      * page retrieved.
134      * </p>
135      *
136      * @param pageNumber the page number to retrieve when paging results.
137      * @param pageSize the size of the page to retrieve when paging results.
138      * @return the loaded entities.
139      */
140     public Collection<?> loadAll(final int pageNumber, final int pageSize);
141 
142     /**
143      * <p>
144      * Does the same thing as {@link #loadAll(int)} with an
145      * additional two arguments called <code>pageNumber</code> and <code>pageSize</code>. The <code>pageNumber</code>
146      * 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
147      * page retrieved.
148      * </p>
149      *
150      * @param transform the flag indicating what transformation to use.
151      * @param pageNumber the page number to retrieve when paging results.
152      * @param pageSize the size of the page to retrieve when paging results.
153      * @return the loaded entities.
154      */
155     public Collection<?> loadAll(final int transform, final int pageNumber, final int pageSize);
156 
157     /**
158      * Creates an instance of SystemVersion and adds it to the persistent store.
159      * @param systemVersion
160      * @return SystemVersion
161      */
162     public SystemVersion create(SystemVersion systemVersion);
163 
164     /**
165      * <p>
166      * Does the same thing as {@link #create(SystemVersion)} with an
167      * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
168      * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
169      * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
170      * transform the entity (into a value object for example). By default, transformation does
171      * not occur.
172      * </p>
173      * @param transform
174      * @param systemVersion
175      * @return Object
176      */
177     public Object create(int transform, SystemVersion systemVersion);
178 
179     /**
180      * Creates a new instance of SystemVersion and adds
181      * from the passed in <code>entities</code> collection
182      *
183      * @param entities the collection of SystemVersion
184      * instances to create.
185      *
186      * @return the created instances.
187      */
188     public Collection<SystemVersion> create(Collection<SystemVersion> entities);
189 
190     /**
191      * <p>
192      * Does the same thing as {@link #create(SystemVersion)} with an
193      * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
194      * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
195      * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
196      * transform the entities (into value objects for example). By default, transformation does
197      * not occur.
198      * </p>
199      * @param transform
200      * @param entities
201      * @return Collection
202      */
203     public Collection<?> create(int transform, Collection<SystemVersion> entities);
204 
205     /**
206      * <p>
207      * Creates a new <code>SystemVersion</code>
208      * instance from <strong>all</strong> attributes and adds it to
209      * the persistent store.
210      * </p>
211      * @param systemVersionLb <html>
212 <head>
213 <style>
214 p {padding:0px; margin:0px;}
215 </style>
216 </head>
217 <body>
218 <p>
219 The version string. Version identifiers should have three or four
220 components:
221 </p>
222 <p>
223 </p>
224 <ol>
225 <li>
226 Major version. A non-negative integer.
227 </li>
228 <li>
229 Minor version. A non-negative integer.
230 </li>
231 <li>
232 Micro version. A non-negative integer.
233 </li>
234 <li>
235 Qualifier (optional). A text string compatible with regex :
236 ([0-9]|[a-zA-Z]|_|-)+
237 </li>
238 </ol>
239 <p>
240 </p>
241 <p>
242 See osgi Version specification : <a
243 href="http://www.osgi.org/javadoc/r4v42/org/osgi/framework/Version.html">http://www.osgi.org/javadoc/r4v42/org/osgi/framework/Version.html</a>
244 </p>
245 <p>
246 </p>
247 <p>
248 Example :
249 </p>
250 <ul>
251 <li>
252 3.4.1
253 </li>
254 <li>
255 3.4.1.20130820
256 </li>
257 <li>
258 ...
259 </li>
260 </ul>
261 <p>
262 </p>
263 </body>
264 </html>
265      * @param systemVersionDc 
266      * @param systemVersionCreationDt 
267      * @param systemVersionCm 
268      * @param updateDt 
269      * @return SystemVersion
270      */
271     public SystemVersion create(
272         String systemVersionLb,
273         String systemVersionDc,
274         Date systemVersionCreationDt,
275         String systemVersionCm,
276         Timestamp updateDt);
277 
278     /**
279      * <p>
280      * Does the same thing as {@link #create(String, String, Date, String, Timestamp)} with an
281      * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
282      * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
283      * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
284      * transform the entity (into a value object for example). By default, transformation does
285      * not occur.
286      * </p>
287      * @param transform
288      * @param systemVersionLb <html>
289 <head>
290 <style>
291 p {padding:0px; margin:0px;}
292 </style>
293 </head>
294 <body>
295 <p>
296 The version string. Version identifiers should have three or four
297 components:
298 </p>
299 <p>
300 </p>
301 <ol>
302 <li>
303 Major version. A non-negative integer.
304 </li>
305 <li>
306 Minor version. A non-negative integer.
307 </li>
308 <li>
309 Micro version. A non-negative integer.
310 </li>
311 <li>
312 Qualifier (optional). A text string compatible with regex :
313 ([0-9]|[a-zA-Z]|_|-)+
314 </li>
315 </ol>
316 <p>
317 </p>
318 <p>
319 See osgi Version specification : <a
320 href="http://www.osgi.org/javadoc/r4v42/org/osgi/framework/Version.html">http://www.osgi.org/javadoc/r4v42/org/osgi/framework/Version.html</a>
321 </p>
322 <p>
323 </p>
324 <p>
325 Example :
326 </p>
327 <ul>
328 <li>
329 3.4.1
330 </li>
331 <li>
332 3.4.1.20130820
333 </li>
334 <li>
335 ...
336 </li>
337 </ul>
338 <p>
339 </p>
340 </body>
341 </html>
342      * @param systemVersionDc 
343      * @param systemVersionCreationDt 
344      * @param systemVersionCm 
345      * @param updateDt 
346      * @return SystemVersion
347      */
348     public Object create(
349         int transform,
350         String systemVersionLb,
351         String systemVersionDc,
352         Date systemVersionCreationDt,
353         String systemVersionCm,
354         Timestamp updateDt);
355 
356 
357     /**
358      * Updates the <code>systemVersion</code> instance in the persistent store.
359      * @param systemVersion
360      */
361     public void update(SystemVersion systemVersion);
362 
363     /**
364      * Updates all instances in the <code>entities</code> collection in the persistent store.
365      * @param entities
366      */
367     public void update(Collection<SystemVersion> entities);
368 
369     /**
370      * Removes the instance of SystemVersion from the persistent store.
371      * @param systemVersion
372      */
373     public void remove(SystemVersion systemVersion);
374 
375     /**
376      * Removes the instance of SystemVersion having the given
377      * <code>identifier</code> from the persistent store.
378      * @param systemVersionId
379      */
380     public void remove(Integer systemVersionId);
381 
382     /**
383      * Removes all entities in the given <code>entities</code> collection.
384      * @param entities
385      */
386     public void remove(Collection<SystemVersion> entities);
387 
388 
389     /**
390      * Does the same thing as {@link #search(int, Search)} but with an
391      * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
392      * limit your data to a specified page number and size.
393      *
394      * @param transform the transformation flag.
395      * @param pageNumber the page number in the data to retrieve
396      * @param pageSize the size of the page to retrieve.
397      * @param search the search object which provides the search parameters and pagination specification.
398      * @return any found results from the search wrapped in a {@link PaginationResult} instance.
399      */
400     public PaginationResult search(final int transform, final int pageNumber, final int pageSize, final Search search);
401 
402     /**
403      * Does the same thing as {@link #search(Search)} but with an
404      * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
405      * limit your data to a specified page number and size.
406      *
407      * @param pageNumber the page number in the data to retrieve
408      * @param pageSize the size of the page to retrieve.
409      * @param search the search object which provides the search parameters and pagination specification.
410      * @return any found results from the search wrapped in a {@link PaginationResult} instance.
411      */
412     public PaginationResult search(final int pageNumber, final int pageSize, final Search search);
413 
414     /**
415      * Does the same thing as {@link #search(Search)} but with an
416      * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
417      * finder results will <strong>NOT</strong> be transformed during retrieval.
418      * If this flag is any of the other constants defined here
419      * then results <strong>WILL BE</strong> passed through an operation which can optionally
420      * transform the entities (into value objects for example). By default, transformation does
421      * not occur.
422      *
423      * @param transform the transformation flag.
424      * @param search the search object which provides the search parameters and pagination specification.
425      * @return any found results from the search.
426      */
427     public Set<?> search(final int transform, final Search search);
428 
429     /**
430      * Performs a search using the parameters specified in the given <code>search</code> object.
431      *
432      * @param search the search object which provides the search parameters and pagination specification.
433      * @return any found results from the search.
434      */
435     public Set<SystemVersion> search(final Search search);
436 
437     /**
438      * Allows transformation of entities into value objects
439      * (or something else for that matter), when the <code>transform</code>
440      * flag is set to one of the constants defined in <code>fr.ifremer.quadrige3.core.dao.system.versionning.SystemVersionDao</code>, please note
441      * that the {@link #TRANSFORM_NONE} constant denotes no transformation, so the entity itself
442      * will be returned.
443      *
444      * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
445      *
446      * @param transform one of the constants declared in {@link fr.ifremer.quadrige3.core.dao.system.versionning.SystemVersionDao}
447      * @param entity an entity that was found
448      * @return the transformed entity (i.e. new value object, etc)
449      * @see #transformEntities(int,Collection)
450      */
451     public Object transformEntity(final int transform, final SystemVersion entity);
452 
453     /**
454      * Transforms a collection of entities using the
455      * {@link #transformEntity(int,SystemVersion)}
456      * method. This method does not instantiate a new collection.
457      * <p>
458      * This method is to be used internally only.
459      *
460      * @param transform one of the constants declared in <code>fr.ifremer.quadrige3.core.dao.system.versionning.SystemVersionDao</code>
461      * @param entities the collection of entities to transform
462      * @see #transformEntity(int,SystemVersion)
463      */
464     public void transformEntities(final int transform, final Collection<?> entities);
465 
466     // spring-dao merge-point
467 }