1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.util.jpa;
35
36 import java.util.List;
37
38 /**
39 * Class GenericDAO
40 *
41 * @param <K>
42 * Type of the entity's key
43 * @param <E>
44 * Type of the entity
45 */
46 public interface IGenericDAO<K, E>
47 {
48 /**
49 * Create an entity
50 *
51 * @param entity
52 * The entity to create
53 */
54 void create( E entity );
55
56 /**
57 * Update an entity
58 *
59 * @param entity
60 * An entity that contains new values
61 */
62 void update( E entity );
63
64 /**
65 * Remove an entity
66 *
67 * @param key
68 * The key of the entity to remove
69 */
70 void remove( K key );
71
72 /**
73 * Find an entity by its Id
74 *
75 * @param key
76 * The entity key
77 * @return The entity object
78 */
79 E findById( K key );
80
81 /**
82 * Find all entities
83 *
84 * @return A list of entities
85 */
86 List<E> findAll( );
87
88 /**
89 * Synchronize the persistence context to the underlying database.
90 */
91 void flush( );
92
93 /**
94 * Remove the given entity from the persistence context, causing a managed entity to become detached.
95 *
96 * @param entity
97 * the entity
98 */
99 void detach( E entity );
100 }