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.
long	getUpdateUserMailMimetypePreferenceCount(String mimetype)
long	getUserLocalePreferenceCount(String localeCode)
Collection	getUserLocalePreferenceList(String localeCode)
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.
void	updateUserMailMimetypePreference(String mimetype) This is used to update all users mimetype mail preference.

Method Detail

addUserToGroup

public 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

public 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

public 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

public 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

updateUserMailMimetypePreference

public void updateUserMailMimetypePreference(String mimetype)
                                      throws org.ofbiz.core.entity.GenericEntityException

This is used to update all users mimetype mail preference.

Parameters:

mimetype -

Throws:

org.ofbiz.core.entity.GenericEntityException

getUpdateUserMailMimetypePreferenceCount

public long getUpdateUserMailMimetypePreferenceCount(String mimetype)
                                              throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getUserLocalePreferenceCount

public long getUserLocalePreferenceCount(String localeCode)

getUserLocalePreferenceList

public Collection getUserLocalePreferenceList(String localeCode)