KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > portal > core > model > Role


1 /*****************************************
2  * *
3  * JBoss Portal: The OpenSource Portal *
4  * *
5  * Distributable under LGPL license. *
6  * See terms of license at gnu.org. *
7  * *
8  *****************************************/

9 package org.jboss.portal.core.model;
10
11 import java.util.Set JavaDoc;
12
13 /**
14  * A role of users.
15  *
16  * @author <a HREF="mailto:julien@jboss.org">Julien Viet</a>
17  * @author <a HREF="mailto:theute@jboss.org">Thomas Heute</a>
18  * @version $Revision: 1.1 $
19  */

20 public interface Role
21 {
22    /**
23     * The role identifier.
24     *
25     * @return the role ID
26     */

27    Integer JavaDoc getID();
28
29    /**
30     * The role name used in security rules. This name can not be modified
31     *
32     * @return the role name
33     */

34    String JavaDoc getName();
35    
36    /**
37     * The role display name used on screens. This name can be modified
38     *
39     * @return the role name
40     */

41    String JavaDoc getDisplayName();
42    
43    void setDisplayName(String JavaDoc name);
44    
45    
46    /**
47     * The users.
48     *
49     * @return the users belonging to this role
50     */

51    Set JavaDoc getUsers();
52 }
53
Popular Tags