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 org.springframework.transaction.annotation.Transactional;
37
38 import java.util.List;
39
40 /**
41 * Interface IGenericLuteceHome
42 *
43 * @param <K>
44 * key class
45 * @param <E>
46 * entity class
47 */
48 public interface IGenericHome<K, E>
49 {
50 /**
51 * Creates the entity
52 *
53 * @param entity
54 * object
55 */
56 void create( E entity );
57
58 /**
59 * Merges the entity
60 *
61 * @param entity
62 * object
63 */
64 void update( E entity );
65
66 /**
67 * Removes the entity if exists
68 *
69 * @param key
70 * The entity key
71 */
72 void remove( K key );
73
74 /**
75 * Loads an entity by its key
76 *
77 * @param pKey
78 * primary key
79 * @return the found entity, <code>null</code> otherwise.
80 */
81 @Transactional( readOnly = true )
82 E findByPrimaryKey( K pKey );
83
84 /**
85 * Finds all
86 *
87 * @return the list
88 */
89 @Transactional( readOnly = true )
90 List<E> findAll( );
91 }