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.rbac;
35
36 import java.util.Collection;
37
38
39 /**
40 * Interface for RBAC DAO
41 */
42 public interface IRBACDAO
43 {
44 /**
45 * Delete a record from the table
46 *
47 * @param nRBACId The id of RBAC object to delete
48 */
49 void delete( int nRBACId );
50
51 /**
52 * Remove all the entries of the given role key
53 *
54 * @param strRoleKey the role key of the entries to remove
55 */
56 void deleteForRoleKey( String strRoleKey );
57
58 /**
59 * Insert a new record in the table.
60 *
61 *
62 * @param rBAC The rBAC object
63 */
64 void insert( RBAC rBAC );
65
66 /**
67 * Load the data of RBAC from the table
68 *
69 *
70 * @param nRBACId The identifier of RBAC
71 * @return the instance of the RBAC
72 */
73 RBAC load( int nRBACId );
74
75 /**
76 * Load the list of rBACs
77 *
78 * @return The Collection of the RBACs
79 */
80 Collection<RBAC> selectRBACList( );
81
82 /**
83 * Find all the entries for a given role key
84 *
85 * @param strRoleKey the role key to search for
86 * @return A collection of rBACs
87 */
88 Collection<RBAC> selectRBACListByRoleKey( String strRoleKey );
89
90 /**
91 *
92 *
93 * @param strTypeCode The type code
94 * @param strId the id
95 * @param strPermission th permission
96 * @return listRoleKeys
97 */
98 Collection<String> selectRoleKeys( String strTypeCode, String strId, String strPermission );
99
100 /**
101 * Update the record in the table
102 *
103 * @param rBAC The reference of rBAC
104 */
105 void store( RBAC rBAC );
106
107 /**
108 * Update the role key of all the entries of a given role key
109 *
110 * @param strOldRoleKey the role key to update
111 * @param strNewRoleKey the new role key
112 */
113 void updateRoleKey( String strOldRoleKey, String strNewRoleKey );
114 }