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