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.right;
35
36 import java.util.Collection;
37
38 /**
39 * RightDAO Interface
40 */
41 public interface IRightDAO
42 {
43 /**
44 * Delete a record from the table
45 *
46 * @param strIdRight
47 * string identifier of the admin right to delete
48 */
49 void delete( String strIdRight );
50
51 /**
52 * Insert a new record in the table.
53 *
54 * @param right
55 * instance of the right to insert
56 */
57 void insert( Right right );
58
59 /**
60 * load the data of the right from the table
61 *
62 * @param strId
63 * The identifier of the admin right
64 * @return The instance of the admin right
65 */
66 Right load( String strId );
67
68 /**
69 * Loads the data of all the rights and returns them in form of a collection
70 *
71 * @return the collection which contains the data of all the rights
72 */
73 Collection<Right> selectRightsList( );
74
75 /**
76 * Update the record in the table
77 *
78 * @param right
79 * the reference of the admin right
80 */
81 void store( Right right );
82
83 /**
84 * Loads the data of all the external admin features with level greater or equal than nLevel and returns them in form of a collection
85 *
86 * @param nLevel
87 * The right level
88 * @return the collection which contains the data of all the external admin features
89 */
90 public Collection<Right> selectExternalRightsList( int nLevel );
91
92 /**
93 * Loads the data of all the rights with level greater or equal than nLevel and returns them in form of a collection
94 *
95 * @param nLevel
96 * The right's level
97 * @return the collection which contains the data of all the rights
98 */
99 Collection<Right> selectRightsList( int nLevel );
100
101 /**
102 * Loads the data of all the rights with the specified feature group and returns them in form of a collection
103 *
104 * @param strFeatureGroup
105 * the name of the feature group
106 * @return the collection which contains the data of all the rights
107 */
108 Collection<Right> selectRightsList( String strFeatureGroup );
109 }