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.portal.business.datastore;
35
36 import java.util.List;
37
38 /**
39 * IDataEntityDAO Interface
40 */
41 public interface IDataEntityDAO
42 {
43 /**
44 * Insert a new record in the table.
45 *
46 * @param entity
47 * instance of the Entity object to insert
48 */
49 void insert( DataEntity entity );
50
51 /**
52 * Update the record in the table
53 *
54 * @param entity
55 * the reference of the Entity
56 */
57 void store( DataEntity entity );
58
59 /**
60 * Delete a record from the table
61 *
62 * @param strKey
63 * The identifier of the Entity to delete
64 */
65 void delete( String strKey );
66
67 // /////////////////////////////////////////////////////////////////////////
68 // Finders
69
70 /**
71 * Load the data from the table
72 *
73 * @param strKey
74 * The identifier of the property
75 * @return The instance of the property
76 */
77 DataEntity load( String strKey );
78
79 /**
80 * Load the data of all entities and returns them as a List
81 *
82 * @return The List which contains the data of all the property objects
83 */
84 List<DataEntity> selectEntitiesList( );
85 }