1 /*
2 * Copyright (c) 2002-2014, Mairie de 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 /**
40 * Class GenericDAO
41 * @param <K> Type of the entity's key
42 * @param <E> Type of the entity
43 */
44 public interface IGenericDAO<K, E>
45 {
46 /**
47 * Create an entity
48 * @param entity The entity to create
49 */
50 void create( E entity );
51
52 /**
53 * Update an entity
54 * @param entity An entity that contains new values
55 */
56 void update( E entity );
57
58 /**
59 * Remove an entity
60 * @param key The key of the entity to remove
61 */
62 void remove( K key );
63
64 /**
65 * Find an entity by its Id
66 * @param key The entity key
67 * @return The entity object
68 */
69 E findById( K key );
70
71 /**
72 * Find all entities
73 * @return A list of entities
74 */
75 List<E> findAll( );
76
77 /**
78 * Synchronize the persistence context to the underlying database.
79 */
80 void flush( );
81
82 /**
83 * Remove the given entity from the persistence context, causing a managed entity to become detached.
84 * @param entity the entity
85 */
86 void detach( E entity );
87 }