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.prefs;
35
36 import java.util.List;
37
38
39 /**
40 * Preferences DAO interface
41 */
42 public interface IPreferencesDAO
43 {
44 /**
45 * Get a preference for a given user
46 * @param strUserId The user's ID
47 * @param strKey The preference's key
48 * @param strDefault The default value
49 * @return The preference's value
50 */
51 String load( String strUserId, String strKey, String strDefault );
52
53 /**
54 * Get the list of user id associated with the given key and value
55 * @param strKey The preference's key
56 * @param strValue The preference's value
57 * @return The list of user id associated with the given key and value. If
58 * there is no user id associated with the parameters, then an empty
59 * list is returned
60 */
61 List<String> getUserId( String strKey, String strValue );
62
63 /**
64 * Store a preference for a given user
65 * @param strUserId The user's ID
66 * @param strKey The preference's key
67 * @param strValue The value
68 */
69 void store( String strUserId, String strKey, String strValue );
70
71 /**
72 * Get all preference keys for a given user
73 * @param strUserId The user's ID
74 * @return The keys
75 */
76 List<String> keys( String strUserId );
77
78 /**
79 * Clear all preferences for a given user
80 * @param strUserId The user's ID
81 */
82 void remove( String strUserId );
83
84 /**
85 * Clear all preferences for a given user
86 * @param strUserId The user's ID
87 * @param strKey The preference's key
88 */
89 void removeKey( String strUserId, String strKey );
90
91 /**
92 * Clear all preferences for a given user
93 * @param strUserId The user's ID
94 * @param strKeyPrefix The key prefix
95 */
96 void removeKeyPrefix( String strUserId, String strKeyPrefix );
97
98 /**
99 * Cheks if a preference key exists
100 * @param strUserId The User ID
101 * @param strKey The Pref key
102 * @return 1 if exists otherwise false
103 */
104 boolean existsKey( String strUserId, String strKey );
105
106 /**
107 * Checks if a value is already used for a preference given key
108 * @param strKey The Pref key
109 * @param strValue The Pref value
110 * @return 1 if exists otherwise false
111 */
112 boolean existsValueForKey( String strKey,String strValue );
113
114
115 }