1 /*
2 * Copyright (c) 2002-2021, 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.plugins.mylutece.modules.database.authentication.business;
35
36 import fr.paris.lutece.portal.service.plugin.Plugin;
37 import fr.paris.lutece.util.ReferenceList;
38
39 import java.util.Collection;
40 import java.util.List;
41
42 /**
43 *
44 *
45 */
46 public interface IGroupDAO
47 {
48 /**
49 * Delete a record from the table
50 *
51 * @param strGroupKey
52 * The indentifier of the object Group
53 * @param plugin
54 * Plugin
55 */
56 void delete( String strGroupKey, Plugin plugin );
57
58 /**
59 * Insert a new record in the table.
60 *
61 * @param group
62 * The Instance of the object Group
63 * @param plugin
64 * Plugin
65 */
66 void insert( Group group, Plugin plugin );
67
68 /**
69 * load the data of Group from the table
70 *
71 * @param strGroupKey
72 * The indentifier of the object Group
73 * @param plugin
74 * Plugin
75 * @return The Instance of the object Group
76 */
77 Group load( String strGroupKey, Plugin plugin );
78
79 /**
80 * Returns a list of all the right group
81 *
82 * @param plugin
83 * Plugin
84 * @return A ReferenceList of group objects
85 */
86 ReferenceList selectGroupsList( Plugin plugin );
87
88 /**
89 * Load the list of groups
90 *
91 * @param plugin
92 * Plugin
93 * @return The Collection of the Groups
94 */
95 Collection<Group> selectAll( Plugin plugin );
96
97 /**
98 * Update the record in the table
99 *
100 * @param group
101 * The instance of the Group to update
102 * @param plugin
103 * Plugin
104 */
105 void store( Group group, Plugin plugin );
106
107 /**
108 * Return the filtered groups list
109 *
110 * @param gFilter
111 * filter
112 * @param plugin
113 * Plugin
114 * @return List of Group
115 */
116 List<Group> selectByFilter( GroupFilter gFilter, Plugin plugin );
117 }