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.business.user.attribute;
35
36 import java.util.List;
37 import java.util.Locale;
38
39 /**
40 *
41 * IAttributeDAO
42 *
43 */
44 public interface IAttributeDAO
45 {
46 /**
47 * Load attribute
48 *
49 * @param nIdAttribute
50 * ID
51 * @param locale
52 * Locale
53 * @return Attribute
54 */
55 IAttribute load( int nIdAttribute, Locale locale );
56
57 /**
58 * Insert a new attribute
59 *
60 * @param attribute
61 * the attribute
62 * @return new PK
63 */
64 int insert( IAttribute attribute );
65
66 /**
67 * Update an attribute
68 *
69 * @param attribute
70 * the attribute
71 */
72 void store( IAttribute attribute );
73
74 /**
75 * Delete an attribute
76 *
77 * @param nIdAttribute
78 * the ID of the attribute
79 */
80 void delete( int nIdAttribute );
81
82 /**
83 * Load every attributes
84 *
85 * @param locale
86 * locale
87 * @return list of attributes
88 */
89 List<IAttribute> selectAll( Locale locale );
90
91 /**
92 * Load every attributes from plugin name
93 *
94 * @param strPluginName
95 * plugin name
96 * @param locale
97 * locale
98 * @return list of attributes
99 */
100 List<IAttribute> selectPluginAttributes( String strPluginName, Locale locale );
101
102 /**
103 * Load every attributes that do not come from a plugin
104 *
105 * @param locale
106 * locale
107 * @return list of attributes
108 */
109 List<IAttribute> selectCoreAttributes( Locale locale );
110
111 /**
112 * Update the anonymization status of the attribute.
113 *
114 * @param nIdAttribute
115 * Id of the attribute
116 * @param bAnonymize
117 * New value of the anonymization status. True means the attribute should be anonymize, false means it doesn't.
118 */
119 void updateAttributeAnonymization( int nIdAttribute, boolean bAnonymize );
120 }