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;
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.util.Collection;
30  import java.util.Date;
31  import java.util.Set;
32  import org.andromda.spring.PaginationResult;
33  
34  /**
35   * Rapport des fiches d'anomalies et d'évolutions gérées dans l'outil Mantis.
36   * Cette table constitue la base des outils de présentation et de synthèse des demandes pour la
37   * cellule d'administration de Quadrige
38   * @see BugReport
39   */
40  public interface BugReportDao
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 BugReport}
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 BugReport from the persistent store.
62       * @param bugId
63       * @return BugReport
64       */
65      public BugReport get(Integer bugId);
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 bugId 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 bugId);
82  
83      /**
84       * Loads an instance of BugReport from the persistent store.
85       * @param bugId
86       * @return BugReport
87       */
88      public BugReport load(Integer bugId);
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 bugId 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 bugId);
105 
106     /**
107      * Loads all entities of type {@link BugReport}.
108      *
109      * @return the loaded entities.
110      */
111     public Collection<BugReport> 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 BugReport and adds it to the persistent store.
159      * @param bugReport
160      * @return BugReport
161      */
162     public BugReport create(BugReport bugReport);
163 
164     /**
165      * <p>
166      * Does the same thing as {@link #create(BugReport)} 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 bugReport
175      * @return Object
176      */
177     public Object create(int transform, BugReport bugReport);
178 
179     /**
180      * Creates a new instance of BugReport and adds
181      * from the passed in <code>entities</code> collection
182      *
183      * @param entities the collection of BugReport
184      * instances to create.
185      *
186      * @return the created instances.
187      */
188     public Collection<BugReport> create(Collection<BugReport> entities);
189 
190     /**
191      * <p>
192      * Does the same thing as {@link #create(BugReport)} 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<BugReport> entities);
204 
205     /**
206      * <p>
207      * Creates a new <code>BugReport</code>
208      * instance from <strong>all</strong> attributes and adds it to
209      * the persistent store.
210      * </p>
211      * @param bugSummary Résumé de la fiche
212      * @param bugDescription Description de la fiche
213      * @param bugReporterName Nom du rapporteur
214      * @param bugStatus Etat de la fiche
215      * @param bugCategory Catégorie de la fiche (anomalie ou évolution)
216      * @param bugPriority Priorité de la fiche
217      * @param bugSeverity Sévérité de la fiche
218      * @param bugSubmittedDate Date de soumission de la fiche
219      * @param bugUpdatedDate Date de mise à jour de la fiche
220      * @param bugWishedDate Date souhaitée pour la mise en oeuvre de la fiche
221      * @param bugClosedDate Date de fermeture de la fiche
222      * @param bugProductVersion Version du produit sur laquelle la fiche a été établie
223      * @param bugFixedVersion Version du produit sur laquelle la fiche a été réalisée
224      * @return BugReport
225      */
226     public BugReport create(
227         String bugSummary,
228         String bugDescription,
229         String bugReporterName,
230         String bugStatus,
231         String bugCategory,
232         String bugPriority,
233         String bugSeverity,
234         Date bugSubmittedDate,
235         Date bugUpdatedDate,
236         Date bugWishedDate,
237         Date bugClosedDate,
238         String bugProductVersion,
239         String bugFixedVersion);
240 
241     /**
242      * <p>
243      * Does the same thing as {@link #create(String, String, String, String, String, String, String, Date, Date, Date, Date, String, String)} with an
244      * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
245      * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
246      * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
247      * transform the entity (into a value object for example). By default, transformation does
248      * not occur.
249      * </p>
250      * @param transform
251      * @param bugSummary Résumé de la fiche
252      * @param bugDescription Description de la fiche
253      * @param bugReporterName Nom du rapporteur
254      * @param bugStatus Etat de la fiche
255      * @param bugCategory Catégorie de la fiche (anomalie ou évolution)
256      * @param bugPriority Priorité de la fiche
257      * @param bugSeverity Sévérité de la fiche
258      * @param bugSubmittedDate Date de soumission de la fiche
259      * @param bugUpdatedDate Date de mise à jour de la fiche
260      * @param bugWishedDate Date souhaitée pour la mise en oeuvre de la fiche
261      * @param bugClosedDate Date de fermeture de la fiche
262      * @param bugProductVersion Version du produit sur laquelle la fiche a été établie
263      * @param bugFixedVersion Version du produit sur laquelle la fiche a été réalisée
264      * @return BugReport
265      */
266     public Object create(
267         int transform,
268         String bugSummary,
269         String bugDescription,
270         String bugReporterName,
271         String bugStatus,
272         String bugCategory,
273         String bugPriority,
274         String bugSeverity,
275         Date bugSubmittedDate,
276         Date bugUpdatedDate,
277         Date bugWishedDate,
278         Date bugClosedDate,
279         String bugProductVersion,
280         String bugFixedVersion);
281 
282 
283     /**
284      * Updates the <code>bugReport</code> instance in the persistent store.
285      * @param bugReport
286      */
287     public void update(BugReport bugReport);
288 
289     /**
290      * Updates all instances in the <code>entities</code> collection in the persistent store.
291      * @param entities
292      */
293     public void update(Collection<BugReport> entities);
294 
295     /**
296      * Removes the instance of BugReport from the persistent store.
297      * @param bugReport
298      */
299     public void remove(BugReport bugReport);
300 
301     /**
302      * Removes the instance of BugReport having the given
303      * <code>identifier</code> from the persistent store.
304      * @param bugId
305      */
306     public void remove(Integer bugId);
307 
308     /**
309      * Removes all entities in the given <code>entities</code> collection.
310      * @param entities
311      */
312     public void remove(Collection<BugReport> entities);
313 
314 
315     /**
316      * Does the same thing as {@link #search(int, Search)} but with an
317      * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
318      * limit your data to a specified page number and size.
319      *
320      * @param transform the transformation flag.
321      * @param pageNumber the page number in the data to retrieve
322      * @param pageSize the size of the page to retrieve.
323      * @param search the search object which provides the search parameters and pagination specification.
324      * @return any found results from the search wrapped in a {@link PaginationResult} instance.
325      */
326     public PaginationResult search(final int transform, final int pageNumber, final int pageSize, final Search search);
327 
328     /**
329      * Does the same thing as {@link #search(Search)} but with an
330      * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
331      * limit your data to a specified page number and size.
332      *
333      * @param pageNumber the page number in the data to retrieve
334      * @param pageSize the size of the page to retrieve.
335      * @param search the search object which provides the search parameters and pagination specification.
336      * @return any found results from the search wrapped in a {@link PaginationResult} instance.
337      */
338     public PaginationResult search(final int pageNumber, final int pageSize, final Search search);
339 
340     /**
341      * Does the same thing as {@link #search(Search)} but with an
342      * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
343      * finder results will <strong>NOT</strong> be transformed during retrieval.
344      * If this flag is any of the other constants defined here
345      * then results <strong>WILL BE</strong> passed through an operation which can optionally
346      * transform the entities (into value objects for example). By default, transformation does
347      * not occur.
348      *
349      * @param transform the transformation flag.
350      * @param search the search object which provides the search parameters and pagination specification.
351      * @return any found results from the search.
352      */
353     public Set<?> search(final int transform, final Search search);
354 
355     /**
356      * Performs a search using the parameters specified in the given <code>search</code> object.
357      *
358      * @param search the search object which provides the search parameters and pagination specification.
359      * @return any found results from the search.
360      */
361     public Set<BugReport> search(final Search search);
362 
363     /**
364      * Allows transformation of entities into value objects
365      * (or something else for that matter), when the <code>transform</code>
366      * flag is set to one of the constants defined in <code>fr.ifremer.quadrige3.core.dao.system.BugReportDao</code>, please note
367      * that the {@link #TRANSFORM_NONE} constant denotes no transformation, so the entity itself
368      * will be returned.
369      *
370      * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
371      *
372      * @param transform one of the constants declared in {@link fr.ifremer.quadrige3.core.dao.system.BugReportDao}
373      * @param entity an entity that was found
374      * @return the transformed entity (i.e. new value object, etc)
375      * @see #transformEntities(int,Collection)
376      */
377     public Object transformEntity(final int transform, final BugReport entity);
378 
379     /**
380      * Transforms a collection of entities using the
381      * {@link #transformEntity(int,BugReport)}
382      * method. This method does not instantiate a new collection.
383      * <p>
384      * This method is to be used internally only.
385      *
386      * @param transform one of the constants declared in <code>fr.ifremer.quadrige3.core.dao.system.BugReportDao</code>
387      * @param entities the collection of entities to transform
388      * @see #transformEntity(int,BugReport)
389      */
390     public void transformEntities(final int transform, final Collection<?> entities);
391 
392     // spring-dao merge-point
393 }