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