Package org.apache.fulcrum.security.torque.dynamic

Class TorqueAbstractDynamicGroup

java.lang.Object

org.apache.fulcrum.security.torque.security.TorqueAbstractSecurityEntity

org.apache.fulcrum.security.torque.dynamic.TorqueAbstractDynamicGroup

All Implemented Interfaces:

Serializable, Group, SecurityEntity, BasicGroup, DynamicGroup, org.apache.torque.om.ObjectModel, org.apache.torque.om.Persistent

Direct Known Subclasses:

BaseTorqueDynamicGroup

public abstract class TorqueAbstractDynamicGroup
extends TorqueAbstractSecurityEntity
implements DynamicGroup

This abstract class provides the SecurityInterface to the managers.

Version:

$Id:$

Author:

Thomas Vandahl

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TorqueAbstractDynamicGroup()

Method Summary

Modifier and Type	Method	Description
void	addRole(Role role)	Add a role to this group
void	addUser(User user)	Add a user to this group
void	delete()	Delete this entity
String	getDatabaseName()
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
protected List<TorqueDynamicGroupRole>	getTorqueDynamicGroupRolesJoinTorqueDynamicRole(org.apache.torque.criteria.Criteria criteria, Connection con)	Forward reference to generated code Get a list of association objects, pre-populated with their TorqueDynamicRole objects.
protected List<TorqueDynamicUserGroup>	getTorqueDynamicUserGroupsJoinTorqueDynamicUser(org.apache.torque.criteria.Criteria criteria, Connection con)	Forward reference to generated code Get a list of association objects, pre-populated with their TorqueDynamicUser objects.
UserSet	getUsers()	Get the users that are part of this group
<T extends User> Set<T>	getUsersAsSet()	Get the users that are part of this group as a Set
void	removeRole(Role role)	Remove a role from this group
void	removeUser(User user)	Remove a user from this group
void	retrieveAttachedObjects(Connection con)	old contract, lazy is set to false.
void	retrieveAttachedObjects(Connection con, Boolean lazy)	Retrieve attached objects such as users, permissions, ...
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
void	setUsers(UserSet userSet)	Set the users that are part of this group
<T extends User> void	setUsersAsSet(Set<T> users)	Set the users that are part of this group as a Set
void	update(Connection con)	Update this instance to the database with all dependent objects

Methods inherited from class org.apache.fulcrum.security.torque.security.TorqueAbstractSecurityEntity

getEntityId, getEntityName, getId, getName, setEntityId, setEntityName, setId, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.torque.om.ObjectModel

getPrimaryKey, isModified, isNew, setModified, setNew, setPrimaryKey, setPrimaryKey

Methods inherited from interface org.apache.torque.om.Persistent

save, save, save

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

getId, getName, setId, setName

Constructor Detail

TorqueAbstractDynamicGroup

public TorqueAbstractDynamicGroup()

Method Detail

getTorqueDynamicUserGroupsJoinTorqueDynamicUser

protected List<TorqueDynamicUserGroup> getTorqueDynamicUserGroupsJoinTorqueDynamicUser(org.apache.torque.criteria.Criteria criteria,
                                                                                       Connection con)
                                                                                throws org.apache.torque.TorqueException

Forward reference to generated code Get a list of association objects, pre-populated with their TorqueDynamicUser objects.

Parameters:

criteria - Criteria to define the selection of records

con - a database connection

Returns:

a list of User/Group relations

Throws:

org.apache.torque.TorqueException - if any database error occurs

getTorqueDynamicGroupRolesJoinTorqueDynamicRole

protected List<TorqueDynamicGroupRole> getTorqueDynamicGroupRolesJoinTorqueDynamicRole(org.apache.torque.criteria.Criteria criteria,
                                                                                       Connection con)
                                                                                throws org.apache.torque.TorqueException

Forward reference to generated code Get a list of association objects, pre-populated with their TorqueDynamicRole objects.

Parameters:

criteria - Criteria to define the selection of records

con - a database connection

Returns:

a list of Role/Group relations

Throws:

org.apache.torque.TorqueException - if any database error occurs

addUser

public void addUser(User user)

Description copied from interface: BasicGroup

Add a user to this group

Specified by:

addUser in interface BasicGroup

Parameters:

user - the user to add

getUsers

public UserSet getUsers()

Description copied from interface: BasicGroup

Get the users that are part of this group

Specified by:

getUsers in interface BasicGroup

Returns:

a set of users

getUsersAsSet

public <T extends User> Set<T> getUsersAsSet()

Description copied from interface: BasicGroup

Get the users that are part of this group as a Set

Specified by:

getUsersAsSet in interface BasicGroup

Type Parameters:

T - User type

Returns:

a set of users

removeUser

public void removeUser(User user)

Description copied from interface: BasicGroup

Remove a user from this group

Specified by:

removeUser in interface BasicGroup

Parameters:

user - the user to remove

setUsers

public void setUsers(UserSet userSet)

Description copied from interface: BasicGroup

Set the users that are part of this group

Specified by:

setUsers in interface BasicGroup

Parameters:

userSet - a set of users

setUsersAsSet

public <T extends User> void setUsersAsSet(Set<T> users)

Description copied from interface: BasicGroup

Set the users that are part of this group as a Set

Specified by:

setUsersAsSet in interface BasicGroup

Type Parameters:

T - User type

Parameters:

users - a set of users

addRole

public void addRole(Role role)

Description copied from interface: DynamicGroup

Add a role to this group

Specified by:

addRole in interface DynamicGroup

Parameters:

role - the role to add

getRoles

public RoleSet getRoles()

Description copied from interface: DynamicGroup

Get the roles that are part of this group

Specified by:

getRoles in interface DynamicGroup

Returns:

a set of roles

getRolesAsSet

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

Description copied from interface: DynamicGroup

Get the roles that are part of this group as Set

Specified by:

getRolesAsSet in interface DynamicGroup

Returns:

a set of roles

removeRole

public void removeRole(Role role)

Description copied from interface: DynamicGroup

Remove a role from this group

Specified by:

removeRole in interface DynamicGroup

Parameters:

role - the role to remove

setRoles

public void setRoles(RoleSet roleSet)

Description copied from interface: DynamicGroup

Set the roles that are part of this group

Specified by:

setRoles in interface DynamicGroup

Parameters:

roleSet - a set of roles

setRolesAsSet

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

Description copied from interface: DynamicGroup

Set the roles that are part of this group as Set

Specified by:

setRolesAsSet in interface DynamicGroup

Parameters:

roles - a set of roles

getDatabaseName

public String getDatabaseName()

Returns:

the database name

retrieveAttachedObjects

public void retrieveAttachedObjects(Connection con)
                             throws DataBackendException

Description copied from class: TorqueAbstractSecurityEntity

old contract, lazy is set to false.

Specified by:

retrieveAttachedObjects in class TorqueAbstractSecurityEntity

Parameters:

con - A database connection

Throws:

DataBackendException - wrapper exception: user information not found exception

retrieveAttachedObjects

public void retrieveAttachedObjects(Connection con,
                                    Boolean lazy)
                             throws DataBackendException

Description copied from class: TorqueAbstractSecurityEntity

Retrieve attached objects such as users, permissions, ...

Specified by:

retrieveAttachedObjects in class TorqueAbstractSecurityEntity

Parameters:

con - A database connection

lazy - if true, may load some or all relationships later

Throws:

DataBackendException

update

public void update(Connection con)
            throws org.apache.torque.TorqueException

Description copied from class: TorqueAbstractSecurityEntity

Update this instance to the database with all dependent objects

Specified by:

update in class TorqueAbstractSecurityEntity

Parameters:

con - A database connection

Throws:

org.apache.torque.TorqueException - database not found exception

delete

public void delete()
            throws org.apache.torque.TorqueException

Description copied from class: TorqueAbstractSecurityEntity

Delete this entity

Specified by:

delete in class TorqueAbstractSecurityEntity

Throws:

org.apache.torque.TorqueException - if any database error occurs if any database operation fails