com.caplin.permissioning

Class Group

java.lang.Object

com.caplin.permissioning.Permissionable

com.caplin.permissioning.Group

public class Group
extends Permissionable

A grouping of users and/or other groups. Any permissions that are applied to the group will be inherited by every member of the group. A user can be a member of more than one group and a group can be a member of other groups.

Field Summary

Fields inherited from class com.caplin.permissioning.Permissionable

name, parents, productPermissionSets

Method Summary

Methods

Modifier and Type	Method and Description
void	addMember(Permissionable member) Adds a member to the group.
java.util.Set<Permissionable>	getMembers() Gets the members that have been added to the group.
void	removeMember(Permissionable member) Removes a member from the group.
java.lang.String	toString() Returns a string representation of Group.

Methods inherited from class com.caplin.permissioning.Permissionable

applyPermission, copyPermissions, deny, equals, getName, hashCode, permit, removeAllPermissions, removePermission

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getMembers

public java.util.Set<Permissionable> getMembers()

Gets the members that have been added to the group.

Returns:

The Set of Group members.

Throws:

java.lang.IllegalStateException - if this Group was removed from the PermissioningDatasource.

addMember

public void addMember(Permissionable member)
               throws InvalidHierarchyException

Adds a member to the group.

Parameters:

member - The member that you want to add.

Throws:

NoTransactionInProgressException - if this method is called outside the scope of a PermissioningDataSource transaction

InvalidHierarchyException - if adding the member will create a cycle in the group hierarchy

java.lang.IllegalStateException - if this Group was removed from the PermissioningDatasource. It will also occur if you are attempting to add a member that has been removed from the PermissioningDataSource.

removeMember

public void removeMember(Permissionable member)
                  throws NoTransactionInProgressException

Removes a member from the group.

Parameters:

member - The member to be removed from this group.

Throws:

NoTransactionInProgressException - if this method is called outside the scope of a PermissioningDataSource transaction

java.lang.IllegalStateException - if this Group was removed from the PermissioningDatasource.

toString

public java.lang.String toString()

Returns a string representation of Group.

Overrides:

toString in class java.lang.Object

Returns:

A string of the form "Group[name, permissions, members]".