org.exoplatform.services.organization

Interface GroupHandler

public interface GroupHandler

Created by The eXo Platform SAS
This interface is a sub part of the organization service. It is used to manage the groups and broadcast the group events to all the registered listeners in the organization service. The group event can be: new group event, update group event and delete group event. Each event should have 2 phases: pre event and post event. The method createGroup(..) , saveGroup(..) and removeGroup broadcast the event at each phase so the listeners can handle the event properly

Author:

Tuan Nguyen

Level API:

Platform

Method Summary

Methods

Modifier and Type	Method and Description
void	addChild(Group parent, Group child, boolean broadcast) Use this method to create a new group.
void	addGroupEventListener(GroupEventListener listener) Use this method to register a group event listener
void	createGroup(Group group, boolean broadcast) Deprecated. This method should not be used , use the addChild(..) method and pass the null as the parent if you want to add the group to the root level.
Group	createGroupInstance()
Group	findGroupById(String groupId) Use this method to search for a group
Collection<Group>	findGroupByMembership(String userName, String membershipType) Use this method to find all the groups of an user with the specified membership type
Collection<Group>	findGroups(Group parent) Use this method to find all the children group of a group.
Collection<Group>	findGroupsOfUser(String user) use this method to look all the group that the user has at least one membership.
Collection<Group>	getAllGroups() Use this method to get all the groups.
Group	removeGroup(Group group, boolean broadcast) Use this method to remove a group from the group database.
void	removeGroupEventListener(GroupEventListener listener) Use this method to unregister a group event listener
Collection<Group>	resolveGroupByMembership(String userName, String membershipType) Use this method to find all the groups of an user with the specified membership type or *.
void	saveGroup(Group group, boolean broadcast) Use this method to update the properties of an existed group.

Method Detail

createGroupInstance

Group createGroupInstance()

Returns:

a new object instance that implement the Group interface

createGroup

void createGroup(Group group,
               boolean broadcast)
                 throws Exception

Deprecated. This method should not be used , use the addChild(..) method and pass the null as the parent if you want to add the group to the root level.

Throws:

Exception

addChild

void addChild(Group parent,
            Group child,
            boolean broadcast)
              throws Exception

Use this method to create a new group. The developer should call createGroupInstance() method to create a group instance, initialize the group properties such owner , label.. and then call this method to persist the group. Use this method only when you are creating a new group. If you want to update a group , use the saveGroup(..) method.

Parameters:

parent - The parent group of the new group. use 'null' if you want to create the group at the root level.

child - The group that you want to create.

broadcast - Broadcast the new group event to all the registered listener if broadcast is true

Throws:

Exception - An exception is thrown if the method fail to persist the new group or there is already one child group with the same group name in the database or any registered listener fail to handle the event.

saveGroup

void saveGroup(Group group,
             boolean broadcast)
               throws Exception

Use this method to update the properties of an existed group. Usually you should use the method findGroupById(..) to find the group, use the methods set to change the data of the group and then call this method to persisted the updated information. You should not call this method with the group instance you get from the createGroupInstance()

Parameters:

group - The group object with the updated information.

broadcast - Broadcast the event to all the registered listener if the broadcast value is true

Throws:

Exception - An exception is thrown if the method cannot access the database or any listener fail to handle the event

removeGroup

Group removeGroup(Group group,
                boolean broadcast)
                  throws Exception

Use this method to remove a group from the group database. If the group has the children group. The method should not remove the group and throw and exception

Parameters:

group - The group to be removed. The group parameter should be obtained form the findGroupId(..) method. When the group is removed, the memberships of the group should be removed as well.

broadcast - Broadcast the event to the registered listener if the broadcast value is 'true'

Returns:

Return the removed group.

Throws:

Exception - An exception is thrown if the method fail to remove the group from the database, the group is not existed in the database, or any listener fail to handle the event.

findGroupByMembership

Collection<Group> findGroupByMembership(String userName,
                                      String membershipType)
                                        throws Exception

Use this method to find all the groups of an user with the specified membership type

Parameters:

userName - The user that the method should search for.

membershipType - The type of the membership. Since an user can have one or more membership in a group, this parameter is necessary. If the membershipType is null, it should mean any membership type.

Returns:

A collection of the found groups

Throws:

Exception - An exception is thrown if the method cannot access the database.

resolveGroupByMembership

Collection<Group> resolveGroupByMembership(String userName,
                                         String membershipType)
                                           throws Exception

Use this method to find all the groups of an user with the specified membership type or *.

Parameters:

userName - The user that the method should search for.

membershipType - The type of the membership. Since an user can have one or more membership in a group, this parameter is necessary. If the membershipType is null, it should mean any membership type.

Returns:

A collection of the found groups

Throws:

Exception - An exception is thrown if the method cannot access the database.

findGroupById

Group findGroupById(String groupId)
                    throws Exception

Use this method to search for a group

Parameters:

groupId - the id of the group that you want to search for

Returns:

null if no record matched the group id or the found group

Throws:

Exception - An exception is thrown if the method cannot access the database or more than one group is found.

findGroups

Collection<Group> findGroups(Group parent)
                             throws Exception

Use this method to find all the children group of a group.

Parameters:

parent - The group that you want to search. Use null if you want to search from the root.

Returns:

A collection of the children group

Throws:

Exception - An exception is thrown is the method cannot access the database

findGroupsOfUser

Collection<Group> findGroupsOfUser(String user)
                                   throws Exception

use this method to look all the group that the user has at least one membership.

Parameters:

user - The username of the user

Returns:

A collection of the found group. The return collection cannot be null, but it can be empty if no group is found.

Throws:

Exception - An exception is thrown if the method cannot access the database.

getAllGroups

Collection<Group> getAllGroups()
                               throws Exception

Use this method to get all the groups. But the third party should not use this method

Throws:

Exception

addGroupEventListener

void addGroupEventListener(GroupEventListener listener)

Use this method to register a group event listener

Parameters:

listener - the group event listener instance.

removeGroupEventListener

void removeGroupEventListener(GroupEventListener listener)

Use this method to unregister a group event listener

Parameters:

listener - the group event listener instance.