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.quadrige2.core.dao.system.rule;
7
8 /*-
9 * #%L
10 * Quadrige2 Core :: Server API
11 * %%
12 * Copyright (C) 2017 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
29 import fr.ifremer.quadrige2.core.dao.Search;
30 import java.sql.Timestamp;
31 import java.util.Collection;
32 import java.util.Set;
33 import org.andromda.spring.PaginationResult;
34
35 /**
36 *
37 * @see RulePrecondition
38 */
39 public interface RulePreconditionDao
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 RulePrecondition}
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 RulePrecondition from the persistent store.
61 * @param rulePrecondId
62 * @return RulePrecondition
63 */
64 public RulePrecondition get(Integer rulePrecondId);
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 rulePrecondId 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 rulePrecondId);
81
82 /**
83 * Loads an instance of RulePrecondition from the persistent store.
84 * @param rulePrecondId
85 * @return RulePrecondition
86 */
87 public RulePrecondition load(Integer rulePrecondId);
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 rulePrecondId 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 rulePrecondId);
104
105 /**
106 * Loads all entities of type {@link RulePrecondition}.
107 *
108 * @return the loaded entities.
109 */
110 public Collection<RulePrecondition> 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 RulePrecondition and adds it to the persistent store.
158 * @param rulePrecondition
159 * @return RulePrecondition
160 */
161 public RulePrecondition create(RulePrecondition rulePrecondition);
162
163 /**
164 * <p>
165 * Does the same thing as {@link #create(RulePrecondition)} 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 rulePrecondition
174 * @return Object
175 */
176 public Object create(int transform, RulePrecondition rulePrecondition);
177
178 /**
179 * Creates a new instance of RulePrecondition and adds
180 * from the passed in <code>entities</code> collection
181 *
182 * @param entities the collection of RulePrecondition
183 * instances to create.
184 *
185 * @return the created instances.
186 */
187 public Collection<RulePrecondition> create(Collection<RulePrecondition> entities);
188
189 /**
190 * <p>
191 * Does the same thing as {@link #create(RulePrecondition)} 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<RulePrecondition> entities);
203
204 /**
205 * <p>
206 * Creates a new <code>RulePrecondition</code>
207 * instance from <strong>all</strong> attributes and adds it to
208 * the persistent store.
209 * </p>
210 * @param rulePrecondLb
211 * @param rulePrecondIsBidir
212 * @param rulePrecondIsActive
213 * @param updateDt
214 * @return RulePrecondition
215 */
216 public RulePrecondition create(
217 String rulePrecondLb,
218 String rulePrecondIsBidir,
219 String rulePrecondIsActive,
220 Timestamp updateDt);
221
222 /**
223 * <p>
224 * Does the same thing as {@link #create(String, String, String, Timestamp)} with an
225 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
226 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
227 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
228 * transform the entity (into a value object for example). By default, transformation does
229 * not occur.
230 * </p>
231 * @param transform
232 * @param rulePrecondLb
233 * @param rulePrecondIsBidir
234 * @param rulePrecondIsActive
235 * @param updateDt
236 * @return RulePrecondition
237 */
238 public Object create(
239 int transform,
240 String rulePrecondLb,
241 String rulePrecondIsBidir,
242 String rulePrecondIsActive,
243 Timestamp updateDt);
244
245 /**
246 * <p>
247 * Creates a new <code>RulePrecondition</code>
248 * instance from only <strong>required</strong> properties (attributes
249 * and association ends) and adds it to the persistent store.
250 * </p>
251 * @param rule
252 * @param rulePrecondIsActive
253 * @param rulePrecondIsBidir
254 * @param rulePrecondLb
255 * @param updateDt
256 * @param usedRule
257 * @return RulePrecondition
258 */
259 public RulePrecondition create(
260 Rule rule,
261 String rulePrecondIsActive,
262 String rulePrecondIsBidir,
263 String rulePrecondLb,
264 Timestamp updateDt,
265 Rule usedRule);
266
267 /**
268 * <p>
269 * Does the same thing as {@link #create(String, String, String, Timestamp)} with an
270 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
271 * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
272 * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
273 * transform the entity (into a value object for example). By default, transformation does
274 * not occur.
275 * </p>
276 * @param transform flag to determine transformation type.
277 * @param rule
278 * @param rulePrecondIsActive
279 * @param rulePrecondIsBidir
280 * @param rulePrecondLb
281 * @param updateDt
282 * @param usedRule
283 * @return Object
284 */
285 public Object create(
286 int transform,
287 Rule rule,
288 String rulePrecondIsActive,
289 String rulePrecondIsBidir,
290 String rulePrecondLb,
291 Timestamp updateDt,
292 Rule usedRule);
293
294 /**
295 * Updates the <code>rulePrecondition</code> instance in the persistent store.
296 * @param rulePrecondition
297 */
298 public void update(RulePrecondition rulePrecondition);
299
300 /**
301 * Updates all instances in the <code>entities</code> collection in the persistent store.
302 * @param entities
303 */
304 public void update(Collection<RulePrecondition> entities);
305
306 /**
307 * Removes the instance of RulePrecondition from the persistent store.
308 * @param rulePrecondition
309 */
310 public void remove(RulePrecondition rulePrecondition);
311
312 /**
313 * Removes the instance of RulePrecondition having the given
314 * <code>identifier</code> from the persistent store.
315 * @param rulePrecondId
316 */
317 public void remove(Integer rulePrecondId);
318
319 /**
320 * Removes all entities in the given <code>entities</code> collection.
321 * @param entities
322 */
323 public void remove(Collection<RulePrecondition> entities);
324
325
326 /**
327 * Does the same thing as {@link #search(int, Search)} but with an
328 * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
329 * limit your data to a specified page number and size.
330 *
331 * @param transform the transformation flag.
332 * @param pageNumber the page number in the data to retrieve
333 * @param pageSize the size of the page to retrieve.
334 * @param search the search object which provides the search parameters and pagination specification.
335 * @return any found results from the search wrapped in a {@link PaginationResult} instance.
336 */
337 public PaginationResult search(final int transform, final int pageNumber, final int pageSize, final Search search);
338
339 /**
340 * Does the same thing as {@link #search(Search)} but with an
341 * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
342 * limit your data to a specified page number and size.
343 *
344 * @param pageNumber the page number in the data to retrieve
345 * @param pageSize the size of the page to retrieve.
346 * @param search the search object which provides the search parameters and pagination specification.
347 * @return any found results from the search wrapped in a {@link PaginationResult} instance.
348 */
349 public PaginationResult search(final int pageNumber, final int pageSize, final Search search);
350
351 /**
352 * Does the same thing as {@link #search(Search)} but with an
353 * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
354 * finder results will <strong>NOT</strong> be transformed during retrieval.
355 * If this flag is any of the other constants defined here
356 * then results <strong>WILL BE</strong> passed through an operation which can optionally
357 * transform the entities (into value objects for example). By default, transformation does
358 * not occur.
359 *
360 * @param transform the transformation flag.
361 * @param search the search object which provides the search parameters and pagination specification.
362 * @return any found results from the search.
363 */
364 public Set<?> search(final int transform, final Search search);
365
366 /**
367 * Performs a search using the parameters specified in the given <code>search</code> object.
368 *
369 * @param search the search object which provides the search parameters and pagination specification.
370 * @return any found results from the search.
371 */
372 public Set<RulePrecondition> search(final Search search);
373
374 /**
375 * Allows transformation of entities into value objects
376 * (or something else for that matter), when the <code>transform</code>
377 * flag is set to one of the constants defined in <code>fr.ifremer.quadrige2.core.dao.system.rule.RulePreconditionDao</code>, please note
378 * that the {@link #TRANSFORM_NONE} constant denotes no transformation, so the entity itself
379 * will be returned.
380 *
381 * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
382 *
383 * @param transform one of the constants declared in {@link fr.ifremer.quadrige2.core.dao.system.rule.RulePreconditionDao}
384 * @param entity an entity that was found
385 * @return the transformed entity (i.e. new value object, etc)
386 * @see #transformEntities(int,Collection)
387 */
388 public Object transformEntity(final int transform, final RulePrecondition entity);
389
390 /**
391 * Transforms a collection of entities using the
392 * {@link #transformEntity(int,RulePrecondition)}
393 * method. This method does not instantiate a new collection.
394 * <p>
395 * This method is to be used internally only.
396 *
397 * @param transform one of the constants declared in <code>fr.ifremer.quadrige2.core.dao.system.rule.RulePreconditionDao</code>
398 * @param entities the collection of entities to transform
399 * @see #transformEntity(int,RulePrecondition)
400 */
401 public void transformEntities(final int transform, final Collection<?> entities);
402
403 // spring-dao merge-point
404 }