TurbineRole (Fulcrum Security API 2.1.0 API)

All Superinterfaces:

Role, SecurityEntity, Serializable, TurbineUserGroupRoleEntity

All Known Implementing Classes:

TurbineRoleImpl
```
public interface TurbineRole
extends Role, TurbineUserGroupRoleEntity
```
Represents the "turbine" model where permissions are in a many to many relationship to roles, roles are related to groups are related to users, all in many to many relationships.

Version:

$Id$

Author:

Eric Pugh

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`addPermission(Permission permission)`	This method should only be used by a RoleManager.
`PermissionSet`	`getPermissions()`	Get the permission that are part of this role
`<T extends Permission> Set<T>`	`getPermissionsAsSet()`	Get the permission that are part of this role as Set
`void`	`removePermission(Permission permission)`	This method should only be used by a RoleManager.
`void`	`setPermissions(PermissionSet permissionSet)`	Set the permission that are part of this role
`<T extends Permission> void`	`setPermissionsAsSet(Set<T> permissions)`	Set the permission that are part of this role as Set

Methods inherited from interface org.apache.fulcrum.security.entity.SecurityEntity
getId, getName, setId, setName

Methods inherited from interface org.apache.fulcrum.security.model.turbine.entity.TurbineUserGroupRoleEntity
addUserGroupRole, getUserGroupRoleSet, removeUserGroupRole, setUserGroupRoleSet

- Method Detail
  - getPermissions
```
PermissionSet getPermissions()
```
    Get the permission that are part of this role
    
    Returns:
    
    a set of permissions
  - getPermissionsAsSet
```
<T extends Permission> Set<T> getPermissionsAsSet()
```
    Get the permission that are part of this role as Set
    
    Returns:
    
    a set of permissions
  - setPermissions
```
void setPermissions(PermissionSet permissionSet)
```
    Set the permission that are part of this role
    
    Parameters:
    
    permissionSet - a set of permissions
  - setPermissionsAsSet
```
<T extends Permission> void setPermissionsAsSet(Set<T> permissions)
```
    Set the permission that are part of this role as Set
    
    Type Parameters:
    
    T - Permission
    
    Parameters:
    
    permissions - a set of permissions
  - addPermission
```
void addPermission(Permission permission)
```
    This method should only be used by a RoleManager. Not directly.
    
    Parameters:
    
    permission - perm to add
  - removePermission
```
void removePermission(Permission permission)
```
    This method should only be used by a RoleManager. Not directly.
    
    Parameters:
    
    permission - perm to remove