com.liferay.portlet.usersadmin.util

Class UsersAdminUtil

java.lang.Object

com.liferay.portlet.usersadmin.util.UsersAdminUtil

public class UsersAdminUtil
extends java.lang.Object

Author:

Brian Wing Shun Chan, Jorge Ferrer, Julio Camarero

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CUSTOM_QUESTION Deprecated. As of 6.2.0, replaced by UsersAdmin.CUSTOM_QUESTION

Constructor Summary

Constructors

Constructor and Description
UsersAdminUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addPortletBreadcrumbEntries(Organization organization, javax.servlet.http.HttpServletRequest request, javax.portlet.RenderResponse renderResponse)
static long[]	addRequiredRoles(long userId, long[] roleIds)
static long[]	addRequiredRoles(User user, long[] roleIds)
static java.util.List<Role>	filterGroupRoles(PermissionChecker permissionChecker, long groupId, java.util.List<Role> roles)
static java.util.List<Group>	filterGroups(PermissionChecker permissionChecker, java.util.List<Group> groups)
static java.util.List<Organization>	filterOrganizations(PermissionChecker permissionChecker, java.util.List<Organization> organizations)
static java.util.List<Role>	filterRoles(PermissionChecker permissionChecker, java.util.List<Role> roles)
static long[]	filterUnsetGroupUserIds(PermissionChecker permissionChecker, long groupId, long[] userIds)
static long[]	filterUnsetOrganizationUserIds(PermissionChecker permissionChecker, long organizationId, long[] userIds)
static java.util.List<UserGroupRole>	filterUserGroupRoles(PermissionChecker permissionChecker, java.util.List<UserGroupRole> userGroupRoles)
static java.util.List<UserGroup>	filterUserGroups(PermissionChecker permissionChecker, java.util.List<UserGroup> userGroups)
static java.util.List<Address>	getAddresses(javax.portlet.ActionRequest actionRequest)
static java.util.List<Address>	getAddresses(javax.portlet.ActionRequest actionRequest, java.util.List<Address> defaultAddresses)
static java.util.List<EmailAddress>	getEmailAddresses(javax.portlet.ActionRequest actionRequest)
static java.util.List<EmailAddress>	getEmailAddresses(javax.portlet.ActionRequest actionRequest, java.util.List<EmailAddress> defaultEmailAddresses)
static OrderByComparator	getGroupOrderByComparator(java.lang.String orderByCol, java.lang.String orderByType)
static java.lang.Long[]	getOrganizationIds(java.util.List<Organization> organizations)
static OrderByComparator	getOrganizationOrderByComparator(java.lang.String orderByCol, java.lang.String orderByType)
static Tuple	getOrganizations(Hits hits)
static java.util.List<OrgLabor>	getOrgLabors(javax.portlet.ActionRequest actionRequest)
static java.util.List<Phone>	getPhones(javax.portlet.ActionRequest actionRequest)
static java.util.List<Phone>	getPhones(javax.portlet.ActionRequest actionRequest, java.util.List<Phone> defaultPhones)
static OrderByComparator	getRoleOrderByComparator(java.lang.String orderByCol, java.lang.String orderByType)
static OrderByComparator	getUserGroupOrderByComparator(java.lang.String orderByCol, java.lang.String orderByType)
static java.util.List<UserGroupRole>	getUserGroupRoles(javax.portlet.PortletRequest portletRequest)
static Tuple	getUserGroups(Hits hits)
static OrderByComparator	getUserOrderByComparator(java.lang.String orderByCol, java.lang.String orderByType)
static Tuple	getUsers(Hits hits)
static UsersAdmin	getUsersAdmin()
static java.util.List<Website>	getWebsites(javax.portlet.ActionRequest actionRequest)
static java.util.List<Website>	getWebsites(javax.portlet.ActionRequest actionRequest, java.util.List<Website> defaultWebsites)
static boolean	hasUpdateEmailAddress(PermissionChecker permissionChecker, User user) Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)
static boolean	hasUpdateFieldPermission(PermissionChecker permissionChecker, User updatingUser, User updatedUser, java.lang.String field)
static boolean	hasUpdateFieldPermission(User user, java.lang.String field) Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)
static boolean	hasUpdateScreenName(PermissionChecker permissionChecker, User user) Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)
static long[]	removeRequiredRoles(long userId, long[] roleIds)
static long[]	removeRequiredRoles(User user, long[] roleIds)
void	setUsersAdmin(UsersAdmin usersAdmin)
static void	updateAddresses(java.lang.String className, long classPK, java.util.List<Address> addresses)
static void	updateEmailAddresses(java.lang.String className, long classPK, java.util.List<EmailAddress> emailAddresses)
static void	updateOrgLabors(long classPK, java.util.List<OrgLabor> orgLabors)
static void	updatePhones(java.lang.String className, long classPK, java.util.List<Phone> phones)
static void	updateWebsites(java.lang.String className, long classPK, java.util.List<Website> websites)

Methods inherited from class java.lang.Object

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

Field Detail

CUSTOM_QUESTION

public static final java.lang.String CUSTOM_QUESTION

Deprecated. As of 6.2.0, replaced by UsersAdmin.CUSTOM_QUESTION

See Also:

Constant Field Values

Constructor Detail

UsersAdminUtil

public UsersAdminUtil()

Method Detail

addPortletBreadcrumbEntries

public static void addPortletBreadcrumbEntries(Organization organization,
                               javax.servlet.http.HttpServletRequest request,
                               javax.portlet.RenderResponse renderResponse)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

addRequiredRoles

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

Throws:

PortalException

SystemException

addRequiredRoles

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

Throws:

PortalException

SystemException

filterGroupRoles

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

Throws:

PortalException

SystemException

filterGroups

public static java.util.List<Group> filterGroups(PermissionChecker permissionChecker,
                                 java.util.List<Group> groups)
                                          throws PortalException,
                                                 SystemException

Throws:

PortalException

SystemException

filterOrganizations

public static java.util.List<Organization> filterOrganizations(PermissionChecker permissionChecker,
                                               java.util.List<Organization> organizations)
                                                        throws PortalException,
                                                               SystemException

Throws:

PortalException

SystemException

filterRoles

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

filterUnsetGroupUserIds

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

Throws:

PortalException

SystemException

filterUnsetOrganizationUserIds

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

Throws:

PortalException

SystemException

filterUserGroupRoles

public static java.util.List<UserGroupRole> filterUserGroupRoles(PermissionChecker permissionChecker,
                                                 java.util.List<UserGroupRole> userGroupRoles)
                                                          throws PortalException,
                                                                 SystemException

Throws:

PortalException

SystemException

filterUserGroups

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

getAddresses

public static java.util.List<Address> getAddresses(javax.portlet.ActionRequest actionRequest)

getAddresses

public static java.util.List<Address> getAddresses(javax.portlet.ActionRequest actionRequest,
                                   java.util.List<Address> defaultAddresses)

getEmailAddresses

public static java.util.List<EmailAddress> getEmailAddresses(javax.portlet.ActionRequest actionRequest)

getEmailAddresses

public static java.util.List<EmailAddress> getEmailAddresses(javax.portlet.ActionRequest actionRequest,
                                             java.util.List<EmailAddress> defaultEmailAddresses)

getGroupOrderByComparator

public static OrderByComparator getGroupOrderByComparator(java.lang.String orderByCol,
                                          java.lang.String orderByType)

getOrganizationIds

public static java.lang.Long[] getOrganizationIds(java.util.List<Organization> organizations)

getOrganizationOrderByComparator

public static OrderByComparator getOrganizationOrderByComparator(java.lang.String orderByCol,
                                                 java.lang.String orderByType)

getOrganizations

public static Tuple getOrganizations(Hits hits)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

getOrgLabors

public static java.util.List<OrgLabor> getOrgLabors(javax.portlet.ActionRequest actionRequest)

getPhones

public static java.util.List<Phone> getPhones(javax.portlet.ActionRequest actionRequest)

getPhones

public static java.util.List<Phone> getPhones(javax.portlet.ActionRequest actionRequest,
                              java.util.List<Phone> defaultPhones)

getRoleOrderByComparator

public static OrderByComparator getRoleOrderByComparator(java.lang.String orderByCol,
                                         java.lang.String orderByType)

getUserGroupOrderByComparator

public static OrderByComparator getUserGroupOrderByComparator(java.lang.String orderByCol,
                                              java.lang.String orderByType)

getUserGroupRoles

public static java.util.List<UserGroupRole> getUserGroupRoles(javax.portlet.PortletRequest portletRequest)
                                                       throws PortalException,
                                                              SystemException

Throws:

PortalException

SystemException

getUserGroups

public static Tuple getUserGroups(Hits hits)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getUserOrderByComparator

public static OrderByComparator getUserOrderByComparator(java.lang.String orderByCol,
                                         java.lang.String orderByType)

getUsers

public static Tuple getUsers(Hits hits)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

getUsersAdmin

public static UsersAdmin getUsersAdmin()

getWebsites

public static java.util.List<Website> getWebsites(javax.portlet.ActionRequest actionRequest)

getWebsites

public static java.util.List<Website> getWebsites(javax.portlet.ActionRequest actionRequest,
                                  java.util.List<Website> defaultWebsites)

hasUpdateEmailAddress

public static boolean hasUpdateEmailAddress(PermissionChecker permissionChecker,
                            User user)
                                     throws PortalException,
                                            SystemException

Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)

Throws:

PortalException

SystemException

hasUpdateFieldPermission

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

Throws:

PortalException

SystemException

hasUpdateFieldPermission

@Deprecated
public static boolean hasUpdateFieldPermission(User user,
                                          java.lang.String field)
                                        throws PortalException,
                                               SystemException

Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)

Throws:

PortalException

SystemException

hasUpdateScreenName

public static boolean hasUpdateScreenName(PermissionChecker permissionChecker,
                          User user)
                                   throws PortalException,
                                          SystemException

Deprecated. As of 6.2.0, replaced by hasUpdateFieldPermission(PermissionChecker, User, User, String)

Throws:

PortalException

SystemException

removeRequiredRoles

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

Throws:

PortalException

SystemException

removeRequiredRoles

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

Throws:

PortalException

SystemException

updateAddresses

public static void updateAddresses(java.lang.String className,
                   long classPK,
                   java.util.List<Address> addresses)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

updateEmailAddresses

public static void updateEmailAddresses(java.lang.String className,
                        long classPK,
                        java.util.List<EmailAddress> emailAddresses)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

updateOrgLabors

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

Throws:

PortalException

SystemException

updatePhones

public static void updatePhones(java.lang.String className,
                long classPK,
                java.util.List<Phone> phones)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

updateWebsites

public static void updateWebsites(java.lang.String className,
                  long classPK,
                  java.util.List<Website> websites)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

setUsersAdmin

public void setUsersAdmin(UsersAdmin usersAdmin)