com.liferay.users.admin.kernel.util

Class UsersAdminUtil

Object

com.liferay.users.admin.kernel.util.UsersAdminUtil

public class UsersAdminUtil
extends Object

Author:

Brian Wing Shun Chan, Jorge Ferrer, Julio Camarero

Constructor Summary

Constructors

Constructor and Description
UsersAdminUtil()

Method Summary

Modifier and Type	Method and Description
static void	addPortletBreadcrumbEntries(Organization organization, javax.servlet.http.HttpServletRequest httpServletRequest, RenderResponse renderResponse)
static long[]	addRequiredRoles(long userId, long[] roleIds)
static long[]	addRequiredRoles(User user, long[] roleIds)
static List<Role>	filterGroupRoles(PermissionChecker permissionChecker, long groupId, List<Role> roles)
static List<Group>	filterGroups(PermissionChecker permissionChecker, List<Group> groups)
static List<Organization>	filterOrganizations(PermissionChecker permissionChecker, List<Organization> organizations)
static List<Role>	filterRoles(PermissionChecker permissionChecker, List<Role> roles)
static long[]	filterUnsetGroupUserIds(PermissionChecker permissionChecker, long groupId, long[] userIds)
static long[]	filterUnsetOrganizationUserIds(PermissionChecker permissionChecker, long organizationId, long[] userIds)
static List<UserGroupRole>	filterUserGroupRoles(PermissionChecker permissionChecker, List<UserGroupRole> userGroupRoles)
static List<UserGroup>	filterUserGroups(PermissionChecker permissionChecker, List<UserGroup> userGroups)
static List<Address>	getAddresses(ActionRequest actionRequest)
static List<Address>	getAddresses(ActionRequest actionRequest, List<Address> defaultAddresses)
static List<EmailAddress>	getEmailAddresses(ActionRequest actionRequest)
static List<EmailAddress>	getEmailAddresses(ActionRequest actionRequest, List<EmailAddress> defaultEmailAddresses)
static long[]	getGroupIds(PortletRequest portletRequest)
static OrderByComparator<Group>	getGroupOrderByComparator(String orderByCol, String orderByType)
static Long[]	getOrganizationIds(List<Organization> organizations)
static long[]	getOrganizationIds(PortletRequest portletRequest)
static OrderByComparator<Organization>	getOrganizationOrderByComparator(String orderByCol, String orderByType)
static List<Organization>	getOrganizations(Hits hits)
static List<OrgLabor>	getOrgLabors(ActionRequest actionRequest)
static List<Phone>	getPhones(ActionRequest actionRequest)
static List<Phone>	getPhones(ActionRequest actionRequest, List<Phone> defaultPhones)
static long[]	getRoleIds(PortletRequest portletRequest)
static OrderByComparator<Role>	getRoleOrderByComparator(String orderByCol, String orderByType)
static <T> String	getUserColumnText(Locale locale, List<? extends T> list, Accessor<T,String> accessor, int count)
static long[]	getUserGroupIds(PortletRequest portletRequest)
static OrderByComparator<UserGroup>	getUserGroupOrderByComparator(String orderByCol, String orderByType)
static List<UserGroupRole>	getUserGroupRoles(PortletRequest portletRequest)
static List<UserGroup>	getUserGroups(Hits hits)
static OrderByComparator<User>	getUserOrderByComparator(String orderByCol, String orderByType)
static List<User>	getUsers(Hits hits)
static UsersAdmin	getUsersAdmin()
static List<Website>	getWebsites(ActionRequest actionRequest)
static List<Website>	getWebsites(ActionRequest actionRequest, List<Website> defaultWebsites)
static boolean	hasUpdateFieldPermission(PermissionChecker permissionChecker, User updatingUser, User updatedUser, String field)
static long[]	removeRequiredRoles(long userId, long[] roleIds)
static long[]	removeRequiredRoles(User user, long[] roleIds)
void	setUsersAdmin(UsersAdmin usersAdmin)
static void	updateAddresses(String className, long classPK, List<Address> addresses)
static void	updateEmailAddresses(String className, long classPK, List<EmailAddress> emailAddresses)
static void	updateOrgLabors(long classPK, List<OrgLabor> orgLabors)
static void	updatePhones(String className, long classPK, List<Phone> phones)
static void	updateWebsites(String className, long classPK, List<Website> websites)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsersAdminUtil

public UsersAdminUtil()

Method Detail

addPortletBreadcrumbEntries

public static void addPortletBreadcrumbEntries(Organization organization,
                                               javax.servlet.http.HttpServletRequest httpServletRequest,
                                               RenderResponse renderResponse)
                                        throws Exception

Throws:

Exception

addRequiredRoles

public static long[] addRequiredRoles(long userId,
                                      long[] roleIds)
                               throws PortalException

Throws:

PortalException

addRequiredRoles

public static long[] addRequiredRoles(User user,
                                      long[] roleIds)
                               throws PortalException

Throws:

PortalException

filterGroupRoles

public static List<Role> filterGroupRoles(PermissionChecker permissionChecker,
                                          long groupId,
                                          List<Role> roles)
                                   throws PortalException

Throws:

PortalException

filterGroups

public static List<Group> filterGroups(PermissionChecker permissionChecker,
                                       List<Group> groups)
                                throws PortalException

Throws:

PortalException

filterOrganizations

public static List<Organization> filterOrganizations(PermissionChecker permissionChecker,
                                                     List<Organization> organizations)
                                              throws PortalException

Throws:

PortalException

filterRoles

public static List<Role> filterRoles(PermissionChecker permissionChecker,
                                     List<Role> roles)

filterUnsetGroupUserIds

public static long[] filterUnsetGroupUserIds(PermissionChecker permissionChecker,
                                             long groupId,
                                             long[] userIds)
                                      throws PortalException

Throws:

PortalException

filterUnsetOrganizationUserIds

public static long[] filterUnsetOrganizationUserIds(PermissionChecker permissionChecker,
                                                    long organizationId,
                                                    long[] userIds)
                                             throws PortalException

Throws:

PortalException

filterUserGroupRoles

public static List<UserGroupRole> filterUserGroupRoles(PermissionChecker permissionChecker,
                                                       List<UserGroupRole> userGroupRoles)
                                                throws PortalException

Throws:

PortalException

filterUserGroups

public static List<UserGroup> filterUserGroups(PermissionChecker permissionChecker,
                                               List<UserGroup> userGroups)

getAddresses

public static List<Address> getAddresses(ActionRequest actionRequest)

getAddresses

public static List<Address> getAddresses(ActionRequest actionRequest,
                                         List<Address> defaultAddresses)

getEmailAddresses

public static List<EmailAddress> getEmailAddresses(ActionRequest actionRequest)

getEmailAddresses

public static List<EmailAddress> getEmailAddresses(ActionRequest actionRequest,
                                                   List<EmailAddress> defaultEmailAddresses)

getGroupIds

public static long[] getGroupIds(PortletRequest portletRequest)
                          throws PortalException

Throws:

PortalException

getGroupOrderByComparator

public static OrderByComparator<Group> getGroupOrderByComparator(String orderByCol,
                                                                 String orderByType)

getOrganizationIds

public static Long[] getOrganizationIds(List<Organization> organizations)

getOrganizationIds

public static long[] getOrganizationIds(PortletRequest portletRequest)
                                 throws PortalException

Throws:

PortalException

getOrganizationOrderByComparator

public static OrderByComparator<Organization> getOrganizationOrderByComparator(String orderByCol,
                                                                               String orderByType)

getOrganizations

public static List<Organization> getOrganizations(Hits hits)
                                           throws PortalException

Throws:

PortalException

getOrgLabors

public static List<OrgLabor> getOrgLabors(ActionRequest actionRequest)

getPhones

public static List<Phone> getPhones(ActionRequest actionRequest)

getPhones

public static List<Phone> getPhones(ActionRequest actionRequest,
                                    List<Phone> defaultPhones)

getRoleIds

public static long[] getRoleIds(PortletRequest portletRequest)
                         throws PortalException

Throws:

PortalException

getRoleOrderByComparator

public static OrderByComparator<Role> getRoleOrderByComparator(String orderByCol,
                                                               String orderByType)

getUserColumnText

public static <T> String getUserColumnText(Locale locale,
                                           List<? extends T> list,
                                           Accessor<T,String> accessor,
                                           int count)

getUserGroupIds

public static long[] getUserGroupIds(PortletRequest portletRequest)
                              throws PortalException

Throws:

PortalException

getUserGroupOrderByComparator

public static OrderByComparator<UserGroup> getUserGroupOrderByComparator(String orderByCol,
                                                                         String orderByType)

getUserGroupRoles

public static List<UserGroupRole> getUserGroupRoles(PortletRequest portletRequest)
                                             throws PortalException

Throws:

PortalException

getUserGroups

public static List<UserGroup> getUserGroups(Hits hits)
                                     throws PortalException

Throws:

PortalException

getUserOrderByComparator

public static OrderByComparator<User> getUserOrderByComparator(String orderByCol,
                                                               String orderByType)

getUsers

public static List<User> getUsers(Hits hits)
                           throws PortalException

Throws:

PortalException

getUsersAdmin

public static UsersAdmin getUsersAdmin()

getWebsites

public static List<Website> getWebsites(ActionRequest actionRequest)

getWebsites

public static List<Website> getWebsites(ActionRequest actionRequest,
                                        List<Website> defaultWebsites)

hasUpdateFieldPermission

public static boolean hasUpdateFieldPermission(PermissionChecker permissionChecker,
                                               User updatingUser,
                                               User updatedUser,
                                               String field)
                                        throws PortalException

Throws:

PortalException

removeRequiredRoles

public static long[] removeRequiredRoles(long userId,
                                         long[] roleIds)
                                  throws PortalException

Throws:

PortalException

removeRequiredRoles

public static long[] removeRequiredRoles(User user,
                                         long[] roleIds)
                                  throws PortalException

Throws:

PortalException

updateAddresses

public static void updateAddresses(String className,
                                   long classPK,
                                   List<Address> addresses)
                            throws PortalException

Throws:

PortalException

updateEmailAddresses

public static void updateEmailAddresses(String className,
                                        long classPK,
                                        List<EmailAddress> emailAddresses)
                                 throws PortalException

Throws:

PortalException

updateOrgLabors

public static void updateOrgLabors(long classPK,
                                   List<OrgLabor> orgLabors)
                            throws PortalException

Throws:

PortalException

updatePhones

public static void updatePhones(String className,
                                long classPK,
                                List<Phone> phones)
                         throws PortalException

Throws:

PortalException

updateWebsites

public static void updateWebsites(String className,
                                  long classPK,
                                  List<Website> websites)
                           throws PortalException

Throws:

PortalException

setUsersAdmin

public void setUsersAdmin(UsersAdmin usersAdmin)