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.rbac;
35
36 import java.util.Collection;
37
38 /**
39 * AdminRoleDAO Interface
40 */
41 public interface IRBACRoleDAO
42 {
43 /**
44 * Check that the given key points to an existing role
45 *
46 * @param strRoleKey
47 * The role key
48 * @return true if the role exists, false otherwise
49 */
50 boolean checkExistRole( String strRoleKey );
51
52 /**
53 * Delete a record from the table
54 *
55 * @param strRoleKey
56 * The RBACRole object
57 */
58 void delete( String strRoleKey );
59
60 /**
61 * Insert a new record in the table.
62 *
63 * @param role
64 * The role object
65 */
66 void insert( RBACRole role );
67
68 /**
69 * Load the data of RBACRole from the table
70 *
71 * @param strRoleKey
72 * The identifier of RBACRole
73 * @return the instance of the RBACRole
74 */
75 RBACRole load( String strRoleKey );
76
77 /**
78 * Load the list of roles
79 *
80 * @return The Collection of the Roles
81 */
82 Collection<RBACRole> selectRoleList( );
83
84 /**
85 * Update the record identified by the given role key with the given role in the table
86 *
87 * @param strRoleKey
88 * the key of the role to modify
89 * @param role
90 * The reference of role to be the new one
91 */
92 void store( String strRoleKey, RBACRole role );
93 }