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 fr.paris.lutece.api.user.UserRole;
37 import java.io.Serializable;
38
39 /**
40 * This class describes a role used by the administration
41 */
42 public class RBACRole implements Serializable, UserRole
43 {
44 private static final long serialVersionUID = 6596841223502982731L;
45 private String _strKey;
46 private String _strDescription;
47
48 /**
49 * Constructor
50 */
51 public RBACRole( )
52 {
53 }
54
55 /**
56 * Constructor
57 *
58 * @param strKey
59 * The Key
60 * @param strDescription
61 * The description
62 */
63 public RBACRole( String strKey, String strDescription )
64 {
65 _strKey = strKey;
66 _strDescription = strDescription;
67 }
68
69 /**
70 * Returns the role Key
71 *
72 * @return The role Key.
73 */
74 @Override
75 public String getKey( )
76 {
77 return _strKey;
78 }
79
80 /**
81 * Sets the role key
82 *
83 * @param strKey
84 * The Key to set.
85 */
86 @Override
87 public void setKey( String strKey )
88 {
89 _strKey = strKey;
90 }
91
92 /**
93 * Returns the role description.
94 *
95 * @return The description.
96 */
97 @Override
98 public String getDescription( )
99 {
100 return _strDescription;
101 }
102
103 /**
104 * Sets the role description
105 *
106 * @param strDescription
107 * The description to set.
108 */
109 @Override
110 public void setDescription( String strDescription )
111 {
112 _strDescription = strDescription;
113 }
114 }