Package org.apache.fulcrum.security.model.dynamic.entity

Interface DynamicGroup

All Superinterfaces:

BasicGroup, Group, SecurityEntity, Serializable

All Known Implementing Classes:

BaseTorqueDynamicGroup, DynamicGroupImpl, TorqueAbstractDynamicGroup, TorqueDynamicGroup

public interface DynamicGroup
extends BasicGroup

Represents the "dynamic" model where permissions are related to roles, roles are related to groups and groups are related to userSet, all in many to many relationships.

Version:

$Id$

Author:

Eric Pugh

Method Summary

Modifier and Type	Method	Description
void	addRole(Role role)	Add a role to this group
RoleSet	getRoles()	Get the roles that are part of this group
<T extends Role> Set<T>	getRolesAsSet()	Get the roles that are part of this group as Set
void	removeRole(Role role)	Remove a role from this group
void	setRoles(RoleSet roleSet)	Set the roles that are part of this group
<T extends Role> void	setRolesAsSet(Set<T> roles)	Set the roles that are part of this group as Set

Methods inherited from interface org.apache.fulcrum.security.model.basic.entity.BasicGroup

addUser, getUsers, getUsersAsSet, removeUser, setUsers, setUsersAsSet

Methods inherited from interface org.apache.fulcrum.security.entity.SecurityEntity

getId, getName, setId, setName

Method Detail

getRoles

RoleSet getRoles()

Get the roles that are part of this group

Returns:

a set of roles

setRoles

void setRoles(RoleSet roleSet)

Set the roles that are part of this group

Parameters:

roleSet - a set of roles

addRole

void addRole(Role role)

Add a role to this group

Parameters:

role - the role to add

removeRole

void removeRole(Role role)

Remove a role from this group

Parameters:

role - the role to remove

setRolesAsSet

<T extends Role> void setRolesAsSet(Set<T> roles)

Set the roles that are part of this group as Set

Parameters:

roles - a set of roles

getRolesAsSet

<T extends Role> Set<T> getRolesAsSet()

Get the roles that are part of this group as Set

Returns:

a set of roles