001// license-header java merge-point
002//
003// Attention: Generated code! Do not modify by hand!
004// Generated by: SpringDao.vsl in andromda-spring-cartridge.
005//
006package fr.ifremer.adagio.core.dao.administration.programStrategy;
007
008/*
009 * #%L
010 * SIH-Adagio :: Core
011 * $Id:$
012 * $HeadURL:$
013 * %%
014 * Copyright (C) 2012 - 2014 Ifremer
015 * %%
016 * This program is free software: you can redistribute it and/or modify
017 * it under the terms of the GNU Affero General Public License as published by
018 * the Free Software Foundation, either version 3 of the License, or
019 * (at your option) any later version.
020 * 
021 * This program is distributed in the hope that it will be useful,
022 * but WITHOUT ANY WARRANTY; without even the implied warranty of
023 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
024 * GNU General Public License for more details.
025 * 
026 * You should have received a copy of the GNU Affero General Public License
027 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
028 * #L%
029 */
030
031import fr.ifremer.adagio.core.dao.Search;
032import fr.ifremer.adagio.core.dao.administration.user.Person;
033import java.util.Collection;
034import java.util.Set;
035import org.andromda.spring.PaginationResult;
036
037/**
038 * <html>
039 * <head>
040 * <style>
041 * p {padding:0px; margin:0px;}
042 * </style>
043 * </head>
044 * <body>
045 * Définis les privilèges d'un utilsiateur sur un progamme, ou sur un
046 * </body>
047 * </html>
048 * @see Program2Person
049 */
050public interface Program2PersonDao
051{
052    /**
053     * This constant is used as a transformation flag; entities can be converted automatically into value objects
054     * or other types, different methods in a class implementing this interface support this feature: look for
055     * an <code>int</code> parameter called <code>transform</code>.
056     * <p>
057     * This specific flag denotes no transformation will occur.
058     */
059    public static final int TRANSFORM_NONE = 0;
060
061
062    /**
063     * Transforms the given results to a collection of {@link Program2Person}
064     * instances (this is useful when the returned results contains a row of data and you want just entities only).
065     *
066     * @param results the query results.
067     */
068    public void toEntities(final Collection<?> results);
069
070    /**
071     * Gets an instance of Program2Person from the persistent store.
072     * @param id
073     * @return Program2Person
074     */
075    public Program2Person get(Integer id);
076
077    /**
078     * <p>
079     * Does the same thing as {@link #get(Integer)} with an
080     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
081     * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
082     * defined in this class then the result <strong>WILL BE</strong> passed through an operation which can
083     * optionally transform the entity (into a value object for example). By default, transformation does
084     * not occur.
085     * </p>
086     *
087     * @param transform flag to determine transformation type.
088     * @param id the identifier of the entity to get.
089     * @return either the entity or the object transformed from the entity.
090     */
091    public Object get(int transform, Integer id);
092
093    /**
094     * Loads an instance of Program2Person from the persistent store.
095     * @param id
096     * @return Program2Person
097     */
098    public Program2Person load(Integer id);
099
100    /**
101     * <p>
102     * Does the same thing as {@link #load(Integer)} with an
103     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
104     * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
105     * defined in this class then the result <strong>WILL BE</strong> passed through an operation which can
106     * optionally transform the entity (into a value object for example). By default, transformation does
107     * not occur.
108     * </p>
109     *
110     * @param transform flag to determine transformation type.
111     * @param id the identifier of the entity to load.
112     * @return either the entity or the object transformed from the entity.
113     */
114    public Object load(int transform, Integer id);
115
116    /**
117     * Loads all entities of type {@link Program2Person}.
118     *
119     * @return the loaded entities.
120     */
121    public Collection<Program2Person> loadAll();
122
123    /**
124     * <p>
125     * Does the same thing as {@link #loadAll()} with an
126     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
127     * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
128     * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
129     * transform the entity (into a value object for example). By default, transformation does
130     * not occur.
131     * </p>
132     *
133     * @param transform the flag indicating what transformation to use.
134     * @return the loaded entities.
135     */
136    public Collection<?> loadAll(final int transform);
137
138    /**
139     * <p>
140     * Does the same thing as {@link #loadAll()} with an
141     * additional two arguments called <code>pageNumber</code> and <code>pageSize</code>. The <code>pageNumber</code>
142     * 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
143     * page retrieved.
144     * </p>
145     *
146     * @param pageNumber the page number to retrieve when paging results.
147     * @param pageSize the size of the page to retrieve when paging results.
148     * @return the loaded entities.
149     */
150    public Collection<?> loadAll(final int pageNumber, final int pageSize);
151
152    /**
153     * <p>
154     * Does the same thing as {@link #loadAll(int)} with an
155     * additional two arguments called <code>pageNumber</code> and <code>pageSize</code>. The <code>pageNumber</code>
156     * 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
157     * page retrieved.
158     * </p>
159     *
160     * @param transform the flag indicating what transformation to use.
161     * @param pageNumber the page number to retrieve when paging results.
162     * @param pageSize the size of the page to retrieve when paging results.
163     * @return the loaded entities.
164     */
165    public Collection<?> loadAll(final int transform, final int pageNumber, final int pageSize);
166
167    /**
168     * Creates an instance of Program2Person and adds it to the persistent store.
169     * @param program2Person
170     * @return Program2Person
171     */
172    public Program2Person create(Program2Person program2Person);
173
174    /**
175     * <p>
176     * Does the same thing as {@link #create(Program2Person)} with an
177     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
178     * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
179     * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
180     * transform the entity (into a value object for example). By default, transformation does
181     * not occur.
182     * </p>
183     * @param transform
184     * @param program2Person
185     * @return Object
186     */
187    public Object create(int transform, Program2Person program2Person);
188
189    /**
190     * Creates a new instance of Program2Person and adds
191     * from the passed in <code>entities</code> collection
192     *
193     * @param entities the collection of Program2Person
194     * instances to create.
195     *
196     * @return the created instances.
197     */
198    public Collection<Program2Person> create(Collection<Program2Person> entities);
199
200    /**
201     * <p>
202     * Does the same thing as {@link #create(Program2Person)} with an
203     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
204     * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
205     * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
206     * transform the entities (into value objects for example). By default, transformation does
207     * not occur.
208     * </p>
209     * @param transform
210     * @param entities
211     * @return Collection
212     */
213    public Collection<?> create(int transform, Collection<Program2Person> entities);
214
215    /**
216     * <p>
217     * Creates a new <code>Program2Person</code>
218     * instance from only <strong>required</strong> properties (attributes
219     * and association ends) and adds it to the persistent store.
220     * </p>
221     * @param person
222     * @param program
223     * @param programPrivilege
224     * @return Program2Person
225     */
226    public Program2Person create(
227        Person person,
228        Program program,
229        ProgramPrivilege programPrivilege);
230
231    /**
232     * <p>
233     * Does the same thing as {@link #create()} with an
234     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
235     * the returned entity will <strong>NOT</strong> be transformed. If this flag is any of the other constants
236     * defined here then the result <strong>WILL BE</strong> passed through an operation which can optionally
237     * transform the entity (into a value object for example). By default, transformation does
238     * not occur.
239     * </p>
240     * @param transform flag to determine transformation type.
241     * @param person
242     * @param program
243     * @param programPrivilege
244     * @return Object
245     */
246    public Object create(
247        int transform,
248        Person person,
249        Program program,
250        ProgramPrivilege programPrivilege);
251
252    /**
253     * Updates the <code>program2Person</code> instance in the persistent store.
254     * @param program2Person
255     */
256    public void update(Program2Person program2Person);
257
258    /**
259     * Updates all instances in the <code>entities</code> collection in the persistent store.
260     * @param entities
261     */
262    public void update(Collection<Program2Person> entities);
263
264    /**
265     * Removes the instance of Program2Person from the persistent store.
266     * @param program2Person
267     */
268    public void remove(Program2Person program2Person);
269
270    /**
271     * Removes the instance of Program2Person having the given
272     * <code>identifier</code> from the persistent store.
273     * @param id
274     */
275    public void remove(Integer id);
276
277    /**
278     * Removes all entities in the given <code>entities</code> collection.
279     * @param entities
280     */
281    public void remove(Collection<Program2Person> entities);
282
283
284    /**
285     * Does the same thing as {@link #search(int, Search)} but with an
286     * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
287     * limit your data to a specified page number and size.
288     *
289     * @param transform the transformation flag.
290     * @param pageNumber the page number in the data to retrieve
291     * @param pageSize the size of the page to retrieve.
292     * @param search the search object which provides the search parameters and pagination specification.
293     * @return any found results from the search wrapped in a {@link PaginationResult} instance.
294     */
295    public PaginationResult search(final int transform, final int pageNumber, final int pageSize, final Search search);
296
297    /**
298     * Does the same thing as {@link #search(Search)} but with an
299     * additional two flags called <code>pageNumber</code> and <code>pageSize</code>. These flags allow you to
300     * limit your data to a specified page number and size.
301     *
302     * @param pageNumber the page number in the data to retrieve
303     * @param pageSize the size of the page to retrieve.
304     * @param search the search object which provides the search parameters and pagination specification.
305     * @return any found results from the search wrapped in a {@link PaginationResult} instance.
306     */
307    public PaginationResult search(final int pageNumber, final int pageSize, final Search search);
308
309    /**
310     * Does the same thing as {@link #search(Search)} but with an
311     * additional flag called <code>transform</code>. If this flag is set to <code>TRANSFORM_NONE</code> then
312     * finder results will <strong>NOT</strong> be transformed during retrieval.
313     * If this flag is any of the other constants defined here
314     * then results <strong>WILL BE</strong> passed through an operation which can optionally
315     * transform the entities (into value objects for example). By default, transformation does
316     * not occur.
317     *
318     * @param transform the transformation flag.
319     * @param search the search object which provides the search parameters and pagination specification.
320     * @return any found results from the search.
321     */
322    public Set<?> search(final int transform, final Search search);
323
324    /**
325     * Performs a search using the parameters specified in the given <code>search</code> object.
326     *
327     * @param search the search object which provides the search parameters and pagination specification.
328     * @return any found results from the search.
329     */
330    public Set<Program2Person> search(final Search search);
331
332    /**
333     * Allows transformation of entities into value objects
334     * (or something else for that matter), when the <code>transform</code>
335     * flag is set to one of the constants defined in <code>Program2PersonDao</code>, please note
336     * that the {@link #TRANSFORM_NONE} constant denotes no transformation, so the entity itself
337     * will be returned.
338     *
339     * If the integer argument value is unknown {@link #TRANSFORM_NONE} is assumed.
340     *
341     * @param transform one of the constants declared in {@link Program2PersonDao}
342     * @param entity an entity that was found
343     * @return the transformed entity (i.e. new value object, etc)
344     * @see #transformEntities(int,Collection)
345     */
346    public Object transformEntity(final int transform, final Program2Person entity);
347
348    /**
349     * Transforms a collection of entities using the
350     * {@link #transformEntity(int,Program2Person)}
351     * method. This method does not instantiate a new collection.
352     * <p>
353     * This method is to be used internally only.
354     *
355     * @param transform one of the constants declared in <code>Program2PersonDao</code>
356     * @param entities the collection of entities to transform
357     * @see #transformEntity(int,Program2Person)
358     */
359    public void transformEntities(final int transform, final Collection<?> entities);
360
361    // spring-dao merge-point
362}