1 /*
2 * Copyright (c) 2002-2014, 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.portal.business.workgroup;
35
36 import fr.paris.lutece.portal.business.user.AdminUser;
37 import fr.paris.lutece.util.ReferenceList;
38
39 import java.util.Collection;
40
41
42 /**
43 * Interface for AdminWorkgroup DAO
44 */
45 public interface IAdminWorkgroupDAO
46 {
47 /**
48 * Check that the given key points to an existing workgroup
49 *
50 * @param strWorkgroupKey The workgroup key
51 * @return true if the workgroup exists, false otherwise
52 */
53 boolean checkExistWorkgroup( String strWorkgroupKey );
54
55 /**
56 * Delete a record from the table
57 *
58 *
59 * @param strWorkgroupKey The workgroup key
60 */
61 void delete( String strWorkgroupKey );
62
63 /**
64 * Insert a new record in the table.
65 *
66 * @param workgroup The workgroup object
67 */
68 void insert( AdminWorkgroup workgroup );
69
70 /**
71 * Load the data of AdminWorkgroup from the table
72 *
73 * @param strWorkgroupKey The workgroup key
74 * @return the instance of the AdminWorkgroup
75 */
76 AdminWorkgroup load( String strWorkgroupKey );
77
78 /**
79 * Load the list of workgroups
80 *
81 * @return The Collection of the Workgroups
82 */
83 Collection<AdminWorkgroup> selectWorkgroupList( );
84
85 /**
86 * Update the record identified by the given workgroup key with the given workgroup in the table
87 * @param workgroup The reference of workgroup to be the new one
88 */
89 void store( AdminWorkgroup workgroup );
90
91 /**
92 * Is the user member of the workgroup
93 *
94 * @param nIdUser The user Id
95 * @param strWorkgroup The workgroup key
96 * @return True if the user is in the workgroup, otherwise false
97 */
98 boolean isUserInWorkgroup( int nIdUser, String strWorkgroup );
99
100 /**
101 * Is the user member of the workgroup
102 *
103 * @param nIdUser The user Id
104 * @return True if the user has workgroup
105 */
106 boolean checkUserHasWorkgroup( int nIdUser );
107
108 /**
109 * Returns the list of all workgroups the user is member
110 *
111 * @param nIdUser The user Id
112 * @return The list of all user's workgroups
113 */
114 ReferenceList getUserWorkgroups( int nIdUser );
115
116 /**
117 * Returns the list of all users for a workgroup
118 *
119 * @param strWorkgroupKey The workgroup key
120 * @return The collection of all users of a workgroup
121 */
122 Collection<AdminUser> getUsersListForWorkgroup( String strWorkgroupKey );
123
124 /**
125 * Remove all users of a workgroup
126 *
127 * @param strWorkgroupKey The workgroup key
128 */
129 void deleteAllUsersForWorkgroup( String strWorkgroupKey );
130
131 /**
132 * Insert a user into a workgroup
133 *
134 * @param user The user to insert
135 * @param strWorkgroupKey the key workgroup
136 */
137 void insertUserForWorkgroup( AdminUser user, String strWorkgroupKey );
138
139 /**
140 * Remove an user from a workgroup
141 * @param userId The user ID
142 * @param strWorkgroupKey The workgroup key
143 */
144 void deleteUserFromWorkgroup( int userId, String strWorkgroupKey );
145
146 /**
147 * Find workgroups from a filter
148 * @param awFilter the filter
149 * @return the list of workgroups
150 */
151 Collection<AdminWorkgroup> selectWorkgroupsByFilter( AdminWorkgroupFilter awFilter );
152 }