org.cyclos.impl.users

Interface GroupsHandler

public interface GroupsHandler

Handler interface for groups. All methods returning Collections of groups are to be placed here.

Methods retrieving groups have the following logic for their names: get[All][Accessible][Basic]Groups()

• The word All indicates that disabled groups are included. Otherwise these are excluded. Disabeld groups (groups with enabled=false) are groups only visible to admins, and which have no users anymore (but had in the past).
• The word Accessible means that groups visible to the logged user are returned. Otherwise any group in the system may be returned (depending other applied filtering).
• The word Basic means that groupsets are included. In such a case, a List is returned. Otherwise, only groups are included and List is returned. In case groupsets are included, the result is always flattened, meaning that the groupsets as well as the contained groups are included in the result, even if the containing groups are not explicitly included in the original collection/entity.
• The word User means that only UserGroups are returned, so admin groups are excluded.

Extra keywords may be included in the method name for methods doing extra filtering beyond this.
The result lists are usually only sorted alphabetically; more sophisticated sorting respecting hierarchy is to be done by GroupService. TODO: The latter may change in future, as listHierarchy is candidate for placement in GroupsHandler.

Author:

luis, rinke

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.collections15.BidiMap<java.lang.Class<? extends BasicGroup>,java.lang.Class<? extends BasicGroupVO>>	VO_MAPPINGS

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAccessAdminGroups() Returns whether the logged user is an admin and manages at least one admin group
boolean	canAccessAdminGroups(User user) Returns whether the given user is an admin and manages at least one admin group
java.util.List<BasicGroupVO>	filterOutEmptyGroupVOSets(java.util.List<? extends BasicGroupVO> basicGroupVOs) Removes the group sets not followed by a group from a hierarchic group list.
java.util.Set<Group>	flatten(java.util.Collection<? extends BasicGroup> basicGroups) Expands the given groups / group sets into a set of groups.
java.util.Set<Group>	flattenIds(java.util.Collection<java.lang.Long> basicGroups) See flatten(Collection), but takes the id's as input.
java.util.Set<Group>	flattenVOs(java.util.Collection<? extends BasicGroupVO> basicGroups) See flatten(Collection), but takes the VO's as input.
java.util.Set<Group>	flattenVOs(java.util.Collection<? extends BasicGroupVO> basicGroupVOs, boolean includeDisabledGroupsOfGroupset) See flatten(Collection), but takes the VO's as input, and includes disabled groups depending on the boolean parameter.
java.util.List<BasicGroup>	getAccessibleBasicGroups() Gets accessible basic groups for the current user.
java.util.List<BasicGroup>	getAccessibleBasicUserGroups() Same as getAccessibleBasicGroups(), but without admin groups.
java.util.List<Group>	getAccessibleGroups() Gets accessible groups for the current user.
java.util.List<Group>	getAccessibleGroups(User user) Returns the accessible groups for the given user, excluding groups with group.enabled=false
java.util.List<UserGroup>	getAccessibleUserGroups() Returns the accessible groups with type=USER and enabled=true for the current user
java.util.List<UserGroup>	getAccessibleUserGroups(User user) Returns the accessible groups with type=USER and enabled=true for the given
java.util.List<AdminGroup>	getAdminGroups() Lists all enabled admin groups
java.util.List<BasicGroup>	getAllAccessibleBasicGroups() Gets accessible basic groups for the current user.
java.util.List<BasicGroup>	getAllAccessibleBasicGroups(Group group) Returns the accessible groups for the given group, including group.enabled=false In case groupsets are included, all of the groups contained in that groupset are also automatically included.
java.util.List<BasicGroup>	getAllAccessibleBasicUserGroups() Same as getAllAccessibleBasicGroups(), but with admin groups excluded.
java.util.List<Group>	getAllAccessibleGroups() Gets accessible groups for the current user, excluding groupsets.
java.util.List<BasicGroup>	getBasicGroups() Returns all groups (including GroupSets) in the system which do not have enabled=false In case groupsets are included, all of the groups contained in that groupset are also automatically included.
java.util.List<BasicGroup>	getBasicUserGroups() Same as getBasicGroups(), but without admin groups.
BasicGroup	getDefaultGroupFilter() Returns the group used by default for searches, if any
AdminGroup	getGlobalAdministrators() Returns the global administrators group
java.util.List<GroupSet>	getGroupSets() Returns the list of group sets.
java.util.List<InitialGroupVO>	getPossiblePublicInitialGroups() Returns the groups either a public user may use to register himself, or a broker to register a new member
java.util.List<Group>	getPossibleRegistrationGroups() Returns the possible initial groups for the loggedUser.
java.util.List<Group>	getPossibleRegistrationGroups(boolean onlyUserGroups) Returns the possible initial groups for the loggedUser.
java.util.List<BasicGroup>	getVisibleGroups(GroupVisibility visibility) Returns either an empty list for GroupVisibility.NONE or null, only visible group sets for GroupVisibility.GROUP_SET or visible groups / group sets for GroupVisibility.GROUP
java.util.List<BasicGroupVO>	sortHierarchy(java.util.Collection<? extends BasicGroup> groups) Returns a sorted list with the groups hierarchically organized

Field Detail

VO_MAPPINGS

static final org.apache.commons.collections15.BidiMap<java.lang.Class<? extends BasicGroup>,java.lang.Class<? extends BasicGroupVO>> VO_MAPPINGS

Method Detail

canAccessAdminGroups

boolean canAccessAdminGroups()

Returns whether the logged user is an admin and manages at least one admin group

canAccessAdminGroups

boolean canAccessAdminGroups(User user)

Returns whether the given user is an admin and manages at least one admin group

filterOutEmptyGroupVOSets

java.util.List<BasicGroupVO> filterOutEmptyGroupVOSets(java.util.List<? extends BasicGroupVO> basicGroupVOs)

Removes the group sets not followed by a group from a hierarchic group list.

Returns:

the same list, but without any GroupSet which is not followed by groups belonging to it.

flatten

java.util.Set<Group> flatten(java.util.Collection<? extends BasicGroup> basicGroups)

Expands the given groups / group sets into a set of groups. Of each encountered groupSet, all the belonging groups are added. The groupset itself is left out.
Disabled groups are included if they are explicitly included in the input collection. If the disabled group belongs to a groupset, and this groupset is included in the input collection (without the disabled group itself being explicitly included), then the disabled group is NOT included in the result. So if you want to include any disabled group, be sure to add it explicitly in the input parameter.

flattenIds

java.util.Set<Group> flattenIds(java.util.Collection<java.lang.Long> basicGroups)

See flatten(Collection), but takes the id's as input.

flattenVOs

java.util.Set<Group> flattenVOs(java.util.Collection<? extends BasicGroupVO> basicGroups)

See flatten(Collection), but takes the VO's as input.

flattenVOs

java.util.Set<Group> flattenVOs(java.util.Collection<? extends BasicGroupVO> basicGroupVOs,
                              boolean includeDisabledGroupsOfGroupset)

See flatten(Collection), but takes the VO's as input, and includes disabled groups depending on the boolean parameter.

Parameters:

includeDisabledGroupsOfGroupset - boolean, if false, the behavior is as flattenVOs(Collection). If true, the disabled groups are included if they are part of a groupSet which is selected, no matter if they are explicitly selected or not.

getAccessibleBasicGroups

java.util.List<BasicGroup> getAccessibleBasicGroups()

Gets accessible basic groups for the current user. Groupsets are included, but groups with enabled=false are excluded. If groupsets are included, their contained groups are automatically also included.

getAccessibleBasicUserGroups

java.util.List<BasicGroup> getAccessibleBasicUserGroups()

Same as getAccessibleBasicGroups(), but without admin groups.

getAccessibleGroups

java.util.List<Group> getAccessibleGroups()

Gets accessible groups for the current user. Groupsets and disabled groups are excluded.

getAccessibleGroups

java.util.List<Group> getAccessibleGroups(User user)

Returns the accessible groups for the given user, excluding groups with group.enabled=false

getAccessibleUserGroups

java.util.List<UserGroup> getAccessibleUserGroups()

Returns the accessible groups with type=USER and enabled=true for the current user

getAccessibleUserGroups

java.util.List<UserGroup> getAccessibleUserGroups(User user)

Returns the accessible groups with type=USER and enabled=true for the given

getAdminGroups

java.util.List<AdminGroup> getAdminGroups()

Lists all enabled admin groups

getAllAccessibleBasicGroups

java.util.List<BasicGroup> getAllAccessibleBasicGroups()

Gets accessible basic groups for the current user. Groups with enabled=false are included. Note that this only make sense for admins, because admins are the only ones who can see disabled groups. So for others than admins the result is the same as getAccessibleBasicGroups(). In case groupsets are included, all of the groups contained in that groupset are also automatically included.

getAllAccessibleBasicGroups

java.util.List<BasicGroup> getAllAccessibleBasicGroups(Group group)

Returns the accessible groups for the given group, including group.enabled=false In case groupsets are included, all of the groups contained in that groupset are also automatically included.

getAllAccessibleBasicUserGroups

java.util.List<BasicGroup> getAllAccessibleBasicUserGroups()

Same as getAllAccessibleBasicGroups(), but with admin groups excluded.

getAllAccessibleGroups

java.util.List<Group> getAllAccessibleGroups()

Gets accessible groups for the current user, excluding groupsets. Groups with enabled=false are included. Note that this only make sense for admins, because admins are the only ones who can see disabled groups. So for others than admins the result is the same as getAccessibleBasicGroups().

getBasicGroups

java.util.List<BasicGroup> getBasicGroups()

Returns all groups (including GroupSets) in the system which do not have enabled=false In case groupsets are included, all of the groups contained in that groupset are also automatically included.

getBasicUserGroups

java.util.List<BasicGroup> getBasicUserGroups()

Same as getBasicGroups(), but without admin groups.

getDefaultGroupFilter

BasicGroup getDefaultGroupFilter()

Returns the group used by default for searches, if any

getGlobalAdministrators

AdminGroup getGlobalAdministrators()

Returns the global administrators group

getGroupSets

java.util.List<GroupSet> getGroupSets()

Returns the list of group sets.

getPossiblePublicInitialGroups

java.util.List<InitialGroupVO> getPossiblePublicInitialGroups()

Returns the groups either a public user may use to register himself, or a broker to register a new member

getPossibleRegistrationGroups

java.util.List<Group> getPossibleRegistrationGroups()

Returns the possible initial groups for the loggedUser.

Returns:

All visible groups in case of an admin, the possible initial groups according to the broker products in case of a broker, and null in other cases.

getPossibleRegistrationGroups

java.util.List<Group> getPossibleRegistrationGroups(boolean onlyUserGroups)

Returns the possible initial groups for the loggedUser.

Returns:

All visible groups in case of an admin, the possible initial groups according to the broker products in case of a broker, and null in other cases. If the flag is true only user groups will be returned.

getVisibleGroups

java.util.List<BasicGroup> getVisibleGroups(GroupVisibility visibility)

Returns either an empty list for GroupVisibility.NONE or null, only visible group sets for GroupVisibility.GROUP_SET or visible groups / group sets for GroupVisibility.GROUP

sortHierarchy

java.util.List<BasicGroupVO> sortHierarchy(java.util.Collection<? extends BasicGroup> groups)

Returns a sorted list with the groups hierarchically organized