com.atlassian.jira.user.util
Interface UserUtil

All Known Implementing Classes:

UserUtilImpl

public interface UserUtil

This is a backend service level interface that defines an api for user level operations.

Method Summary

void	addUserToGroup(Group group, User userToAdd) This is used to add a specified user to a specified group.
void	addUserToGroups(List groups, User userToAdd) This is used to add a user to many groups at once.
void	removeUserFromGroup(Group group, User userToRemove) This is used to remove a specified user from a specified group.
void	removeUserFromGroups(List groups, User userToRemove) This is used to remove a user from many groups at once.

Method Detail

addUserToGroup

void addUserToGroup(Group group,
                    User userToAdd)
                    throws org.ofbiz.core.entity.GenericEntityException,
                           IndexException

This is used to add a specified user to a specified group. The user will be added to the group if the user is not already a member of the group.

Parameters:

group - the group to add the user to.

userToAdd - the user to add to the group.

Throws:

org.ofbiz.core.entity.GenericEntityException

IndexException

addUserToGroups

void addUserToGroups(List groups,
                     User userToAdd)
                     throws org.ofbiz.core.entity.GenericEntityException,
                            IndexException

This is used to add a user to many groups at once.

Parameters:

groups - a list containing the groups to add the user to.

userToAdd - the user to add to the group.

Throws:

org.ofbiz.core.entity.GenericEntityException

IndexException

removeUserFromGroup

void removeUserFromGroup(Group group,
                         User userToRemove)
                         throws org.ofbiz.core.entity.GenericEntityException,
                                IndexException

This is used to remove a specified user from a specified group. The user will be removed from the group only if the user is already a member of the group.

Parameters:

group - the group to add the user to.

userToRemove - the user to add to the group.

Throws:

org.ofbiz.core.entity.GenericEntityException

IndexException

removeUserFromGroups

void removeUserFromGroups(List groups,
                          User userToRemove)
                          throws org.ofbiz.core.entity.GenericEntityException,
                                 IndexException

This is used to remove a user from many groups at once.

Parameters:

groups - a list containing the groups to add the user to.

userToRemove - the user to add to the group.

Throws:

org.ofbiz.core.entity.GenericEntityException

IndexException