1 /*
2 * Copyright (c) 2002-2019, 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.plugins.cgu.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.util.ReferenceList;
38 import java.util.List;
39
40 /**
41 * ICguDAO Interface
42 */
43 public interface ICguDAO
44 {
45 /**
46 * Insert a new record in the table.
47 *
48 * @param cgu
49 * instance of the Cgu object to insert
50 * @param plugin
51 * the Plugin
52 */
53 void insert( Cgu cgu, Plugin plugin );
54
55 /**
56 * Update the record in the table
57 *
58 * @param cgu
59 * the reference of the Cgu
60 * @param plugin
61 * the Plugin
62 */
63 void store( Cgu cgu, Plugin plugin );
64
65 // /////////////////////////////////////////////////////////////////////////
66 // Finders
67
68 /**
69 * Load the data from the table
70 *
71 * @param nKey
72 * The identifier of the cgu
73 * @param plugin
74 * the Plugin
75 * @return The instance of the cgu
76 */
77 Cgu load( int nKey, Plugin plugin );
78
79 /**
80 * Load the data of all the cgu objects and returns them as a list
81 *
82 * @param plugin
83 * the Plugin
84 * @return The list which contains the data of all the cgu objects
85 */
86 List<Cgu> selectCguList( Plugin plugin );
87
88 /**
89 * Load the id of all the cgu objects and returns them as a list
90 *
91 * @param plugin
92 * the Plugin
93 * @return The list which contains the id of all the cgu objects
94 */
95 List<Integer> selectIdCguList( Plugin plugin );
96
97 /**
98 * Load the data of all the cgu objects and returns them as a referenceList
99 *
100 * @param plugin
101 * the Plugin
102 * @return The referenceList which contains the data of all the cgu objects
103 */
104 ReferenceList selectCguReferenceList( Plugin plugin );
105
106 /**
107 * return cgu with cgu code
108 *
109 * @param strCguCode
110 * the cguCode
111 * @param plugin
112 * the Plugin
113 * @return cgu
114 */
115 Cgu selectByCode( String strCguCode, Plugin plugin );
116 }