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.portal.service.spring.SpringContextService;
38 import fr.paris.lutece.util.ReferenceList;
39
40 import java.util.Collection;
41 import java.util.List;
42
43 /**
44 * This class provides instances management methods (create, find, ...) for Group right objects
45 */
46 public final class GroupHome
47 {
48 // Static variable pointed at the DAO instance
49 private static IGroupDAO _dao = SpringContextService.getBean( "mylutece-database.databaseGroupDAO" );
50
51 /**
52 * Creates a new GroupHome object.
53 */
54 private GroupHome( )
55 {
56 }
57
58 /**
59 * Creation of an instance of a mode
60 *
61 * @param group
62 * An instance of a group which contains the informations to create
63 * @param plugin
64 * Plugin
65 * @return The instance of a mode which has been created with its primary key.
66 */
67 public static Groupf="../../../../../../../../../fr/paris/lutece/plugins/mylutece/modules/database/authentication/business/Group.html#Group">Group create( Group group, Plugin plugin )
68 {
69 _dao.insert( group, plugin );
70
71 return group;
72 }
73
74 /**
75 * Update of the mode which is specified
76 *
77 * @param group
78 * The instance of the group which contains the data to store
79 * @param plugin
80 * Plugin
81 * @return The instance of the mode which has been updated
82 */
83 public static Groupf="../../../../../../../../../fr/paris/lutece/plugins/mylutece/modules/database/authentication/business/Group.html#Group">Group update( Group group, Plugin plugin )
84 {
85 _dao.store( group, plugin );
86
87 return group;
88 }
89
90 /**
91 * Remove the mode whose identifier is specified in parameter
92 *
93 * @param strGroupKey
94 * The identifier of the group to remove
95 * @param plugin
96 * Plugin
97 */
98 public static void remove( String strGroupKey, Plugin plugin )
99 {
100 _dao.delete( strGroupKey, plugin );
101 }
102
103 ///////////////////////////////////////////////////////////////////////////
104 // Finders
105
106 /**
107 * Returns an instance of an group whose identifier is specified in parameter
108 *
109 * @param strGroupKey
110 * The mode primary key
111 * @param plugin
112 * Plugin
113 * @return an instance of a group
114 */
115 public static Group findByPrimaryKey( String strGroupKey, Plugin plugin )
116 {
117 return _dao.load( strGroupKey, plugin );
118 }
119
120 /**
121 * Return the list of all groups
122 *
123 * @param plugin
124 * Plugin
125 * @return A ReferenceList of groups
126 */
127 public static ReferenceList getGroupsList( Plugin plugin )
128 {
129 return _dao.selectGroupsList( plugin );
130 }
131
132 /**
133 * Returns the groups list
134 *
135 * @param plugin
136 * Plugin
137 * @return Collection of Group
138 */
139 public static Collection<Group> findAll( Plugin plugin )
140 {
141 return _dao.selectAll( plugin );
142 }
143
144 /**
145 * Return the filtered groups list
146 *
147 * @param gFilter
148 * filter
149 * @param plugin
150 * Plugin
151 * @return List of Group
152 */
153 public static List<Group> findByFilter( GroupFilter gFilter, Plugin plugin )
154 {
155 return _dao.selectByFilter( gFilter, plugin );
156 }
157 }