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.business.attribute;
35
36 import fr.paris.lutece.portal.business.user.AdminUser;
37
38 import java.util.List;
39 import java.util.Locale;
40
41 import javax.servlet.http.HttpServletRequest;
42
43 /**
44 *
45 * MyLuteceUserFieldListener
46 *
47 */
48 public interface MyLuteceUserFieldListener
49 {
50 /**
51 * Create user fields
52 *
53 * @param nIdUser
54 * The Id of the user
55 * @param request
56 * HttpServletRequest
57 * @param locale
58 * locale
59 */
60 void doCreateUserFields( int nIdUser, HttpServletRequest request, Locale locale );
61
62 /**
63 * Create user fields. This method may do nothing if user fields can not be created just from a String value.
64 *
65 * @param nIdUser
66 * The Id of the user
67 * @param listUserFields
68 * The list of user fields to create
69 * @param locale
70 * locale
71 */
72 void doCreateUserFields( int nIdUser, List<MyLuteceUserField> listUserFields, Locale locale );
73
74 /**
75 * Modify user fields
76 *
77 * @param nIdUser
78 * The Id of the user
79 * @param request
80 * HttpServletRequest
81 * @param locale
82 * locale
83 * @param currentUser
84 * current user. The current user may be null.
85 */
86 void doModifyUserFields( int nIdUser, HttpServletRequest request, Locale locale, AdminUser currentUser );
87
88 /**
89 * Modify user fields
90 *
91 * @param nIdUser
92 * The Id of the user
93 * @param listUserFields
94 * The list of user fields to update
95 * @param locale
96 * locale
97 * @param currentUser
98 * current user. The current user may be null.
99 */
100 void doModifyUserFields( int nIdUser, List<MyLuteceUserField> listUserFields, Locale locale, AdminUser currentUser );
101
102 /**
103 * Remove user fields
104 *
105 * @param nIdUser
106 * The Id of the user
107 * @param request
108 * HttpServletRequest
109 * @param locale
110 * locale
111 */
112 void doRemoveUserFields( int nIdUser, HttpServletRequest request, Locale locale );
113
114 /**
115 * Remove user fields
116 *
117 * @param nIdUser
118 * The Id of the user
119 * @param locale
120 * locale
121 */
122 void doRemoveUserFields( int nIdUser, Locale locale );
123 }