1 /*
2 * Copyright (c) 2002-2022, 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.portal.service.prefs;
35
36 import fr.paris.lutece.portal.service.security.LuteceUser;
37
38 /**
39 * IPortalUserPreferencesService
40 */
41 public interface IPortalUserPreferencesService extends IUserPreferencesService
42 {
43 /**
44 * Gets the user's nickname
45 *
46 * @param strUserId
47 * The User ID
48 * @return The nickname
49 */
50 String getNickname( String strUserId );
51
52 /**
53 * Gets the user's nickname
54 *
55 * @param user
56 * The User
57 * @return The nickname
58 */
59 String getNickname( LuteceUser user );
60
61 /**
62 * Sets the nickname
63 *
64 * @param strUserId
65 * The User ID
66 * @param strNickname
67 * The nickname
68 */
69 void setNickname( String strUserId, String strNickname );
70
71 /**
72 * return true if the nickname already exist
73 *
74 * @param strNickname
75 * The nickname
76 * @return true if the nickname already exist
77 */
78 boolean existsNickname( String strNickname );
79 }