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 fr.paris.lutece.portal.business.user.AdminUser;
37
38 import java.util.List;
39
40 /**
41 *
42 * IAdminUserFieldDAO
43 *
44 */
45 public interface IAdminUserFieldDAO
46 {
47 /**
48 * Load the user field
49 *
50 * @param nIdUserField
51 * ID
52 * @return AdminUserField
53 */
54 AdminUserField load( int nIdUserField );
55
56 /**
57 * Insert a new user field
58 *
59 * @param userField
60 * the user field
61 */
62 void insert( AdminUserField userField );
63
64 /**
65 * Update an user field
66 *
67 * @param userField
68 * the user field
69 */
70 void store( AdminUserField userField );
71
72 /**
73 * Delete an attribute
74 *
75 * @param nIdUserField
76 * the ID of the user field
77 */
78 void delete( int nIdUserField );
79
80 /**
81 * Delete all user fields from given id field
82 *
83 * @param nIdField
84 * id field
85 */
86 void deleteUserFieldsFromIdField( int nIdField );
87
88 /**
89 * Delete all user fields from given id user
90 *
91 * @param nIdUser
92 * id user
93 */
94 void deleteUserFieldsFromIdUser( int nIdUser );
95
96 /**
97 * Delete all user fields from given id attribute
98 *
99 * @param nIdAttribute
100 * id attribute
101 */
102 void deleteUserFieldsFromIdAttribute( int nIdAttribute );
103
104 /**
105 * Load all the user field by a given ID user
106 *
107 * @param nIdUser
108 * the ID user
109 * @param nIdAttribute
110 * the ID attribute
111 * @return a list of adminuserfield
112 */
113 List<AdminUserField> selectUserFieldsByIdUserIdAttribute( int nIdUser, int nIdAttribute );
114
115 /**
116 * Load users by a given filter
117 *
118 * @param auFieldFilter
119 * the filter
120 * @return a list of users
121 */
122 List<AdminUser> selectUsersByFilter( AdminUserFieldFilter auFieldFilter );
123
124 /**
125 * Select by filter.
126 *
127 * @param auFieldFilter
128 * the filter
129 * @return the list
130 */
131 List<AdminUserField> selectByFilter( AdminUserFieldFilter auFieldFilter );
132
133 /**
134 * Is the file associated with an attribute
135 *
136 * @param nIdFile
137 * the id file
138 * @return wheter the file is associated with an attribute
139 */
140 boolean existsWithFile( int nIdFile );
141
142 }