com.communote.server.core.user

Interface UserGroupManagement

All Known Implementing Classes:

UserGroupManagementBase, UserGroupManagementImpl

public interface UserGroupManagement

Manage an user group.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
Long	createExternalGroup(ExternalGroupVO groupVO) Create a group imported from an external system.
Group	createGroup(GroupVO groupVO) Create a new group.
Long	createOrUpdateExternalGroup(ExternalGroupVO groupVO) Create a group imported from an external system or if that group already exists it is updated.
void	deleteExternalGroup(Long groupId, String externalSystemId) Delete an external group.
void	deleteGroup(Long groupId) Delete a group.
<T> T	findGroupByAlias(String alias, Converter<Group,T> converter) Find a user group by its alias and convert it to the object to be returned.
<T> T	findGroupById(Long id, Converter<Group,T> converter) Find a user group by its ID and convert it to the object to be returned.
boolean	isExternalGroup(Long groupId) Test whether a group is an external group or an internal group.
void	updateExternalGroup(Long groupId, ExternalGroupVO groupVO) Update a group that was imported from an external system.
void	updateGroup(Long groupId, GroupVO groupVO) Update an existing group.

Method Detail

createExternalGroup

Long createExternalGroup(ExternalGroupVO groupVO)
                  throws AliasValidationException,
                         AliasAlreadyExistsException,
                         GroupAlreadyExistsException

Create a group imported from an external system.

Parameters:

groupVO - a value object with details about the group. If the alias member is not set it will be generated from the name.

Returns:

the ID of the created group

Throws:

AliasValidationException - in case the alias field is not valid

AliasAlreadyExistsException - in case the alias already exists

GroupAlreadyExistsException - in case there is already a local group for the external group

createGroup

Group createGroup(GroupVO groupVO)
           throws AliasAlreadyExistsException,
                  AliasValidationException,
                  AuthorizationException

Create a new group.

Throws:

AuthorizationException - in case the current user is not the client manager or the internal system user

AliasAlreadyExistsException

AliasValidationException

createOrUpdateExternalGroup

Long createOrUpdateExternalGroup(ExternalGroupVO groupVO)
                          throws AliasValidationException,
                                 AliasAlreadyExistsException

Create a group imported from an external system or if that group already exists it is updated.

Parameters:

groupVO - a value object with details about the group. If the alias member is not set it will be generated from the name.

Returns:

the ID of the created group

Throws:

AliasValidationException - in case the alias field is not valid

AliasAlreadyExistsException - in case the alias already exists

deleteExternalGroup

void deleteExternalGroup(Long groupId,
                         String externalSystemId)
                  throws AuthorizationException

Delete an external group. If the group does not exist nothing will happen.

Throws:

AuthorizationException - in case the current user is not the internal system user

deleteGroup

void deleteGroup(Long groupId)
          throws GroupOperationNotPermittedException,
                 AuthorizationException

Delete a group. The group members are note deleted.

Parameters:

groupId - the Id of the group to delete

Throws:

GroupOperationNotPermittedException - if the group refers to an external group

AuthorizationException - if the current user is not client manager

findGroupByAlias

<T> T findGroupByAlias(String alias,
                       Converter<Group,T> converter)

Find a user group by its alias and convert it to the object to be returned.

Type Parameters:

T - the type of the target object

Parameters:

alias - the alias of the group to retrieve

converter - the converter to create the target object

Returns:

the found group as an instance of the target type or null if the group wasn't found

findGroupById

<T> T findGroupById(Long id,
                    Converter<Group,T> converter)

Find a user group by its ID and convert it to the object to be returned.

Type Parameters:

T - the type of the target object

Parameters:

id - the ID of the group to retrieve

converter - the converter to create the target object

Returns:

the found group as an instance of the target type or null if the group wasn't found

isExternalGroup

boolean isExternalGroup(Long groupId)

Test whether a group is an external group or an internal group.

Parameters:

groupId - the ID of the group to test

Returns:

true if the group exists and is an external group, false otherwise

updateExternalGroup

void updateExternalGroup(Long groupId,
                         ExternalGroupVO groupVO)
                  throws GroupNotFoundException

Update a group that was imported from an external system. The alias won't be changed.

Parameters:

groupId - ID of the group to update

groupVO - a value object with details about the group

Throws:

GroupNotFoundException - in case the group to update does not exist

updateGroup

void updateGroup(Long groupId,
                 GroupVO groupVO)
          throws GroupNotFoundException,
                 GroupOperationNotPermittedException

Update an existing group. The alias won't be changed.

Parameters:

groupId - the ID of the group to update

groupVO - a value object with details about the group

Throws:

GroupNotFoundException - in case the group to update does not exist

GroupNotFoundException - in case the group is an external group

GroupOperationNotPermittedException