View Javadoc
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.role;
35  
36  import fr.paris.lutece.portal.service.rbac.RBACResource;
37  import fr.paris.lutece.portal.service.workgroup.AdminWorkgroupResource;
38  
39  /**
40   * This class represents business objects role
41   */
42  public class Role implements RBACResource, AdminWorkgroupResource
43  {
44      public static final String RESOURCE_TYPE = "ROLE_TYPE";
45      private String _strRole;
46      private String _strRoleDescription;
47      private String _strWorkgroupKey;
48  
49      /**
50       * Gets the role name
51       * 
52       * @return the role name
53       */
54      public String getRole( )
55      {
56          return _strRole;
57      }
58  
59      /**
60       * Sets the role name
61       * 
62       * @param strRole
63       *            the role name
64       */
65      public void setRole( String strRole )
66      {
67          _strRole = ( strRole != null ) ? strRole : "";
68      }
69  
70      /**
71       * Gets the role description
72       * 
73       * @return the role description
74       */
75      public String getRoleDescription( )
76      {
77          return _strRoleDescription;
78      }
79  
80      /**
81       * Sets the role description
82       * 
83       * @param strRoleDescription
84       *            the role description
85       */
86      public void setRoleDescription( String strRoleDescription )
87      {
88          _strRoleDescription = strRoleDescription;
89      }
90  
91      /**
92       * RBAC resource implmentation
93       * 
94       * @return The resource type code
95       */
96      public String getResourceTypeCode( )
97      {
98          return RESOURCE_TYPE;
99      }
100 
101     /**
102      * RBAC resource implmentation
103      * 
104      * @return The resourceId
105      */
106     public String getResourceId( )
107     {
108         return getRole( );
109     }
110 
111     /**
112      * Get workgroup key
113      * 
114      * @return workgroup key
115      */
116     public String getWorkgroup( )
117     {
118         return _strWorkgroupKey;
119     }
120 
121     /**
122      * Set workgroup key
123      * 
124      * @param strWorkgroupKey
125      *            workgroup key
126      */
127     public void setWorkgroup( String strWorkgroupKey )
128     {
129         _strWorkgroupKey = strWorkgroupKey;
130     }
131 }