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